Create Payment

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/createPayment

Use the Create Payment endpoint to move funds into a customer account. This endpoint may return load limit and velocity violations in its response. Payments created with this endpoint are returned by the Get Account Overview endpoint only after several seconds have elapsed.

Load limit and velocity response

If the payment violates load or velocity limits, this endpoint returns status: 26 with limit_error, limit_id, and limit_response_code values. Use the limit_id for troubleshooting the load and velocity configuration. The limit_response_code values are enumerated in the Limit Response Codes table.

Consult the Creating a Payment guide for instructions on using this endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

apiLogin

string

required

Web service username, as provided by Galileo.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by Galileo.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string

required

^$|^([0-9]{12}|[0-9]{16})$

The PRN or PAN of the account.
Pattern: PAN or PRN
Example: "074103447228"

amount

float

required

Currency amount as a whole or decimal amount.
Pattern: Positive integer or decimal number
Example: 100.00, 100, or 100.73

type

string

required

^[a-zA-Z0-9]{1,2}$

The transaction type (otype) for the payment. Use the values provided by Galileo for your program.
Pattern: 2-character alphanumeric
Example: "RL"

description

string | null

^([\w\W\s\d]{1,40})$

Description for the transaction. If type is an otype that was custom-configured for your program, the description for that otype might override the description you provide here, depending on your setup with Galileo.
Pattern: 1–40 alphanumeric characters, including punctuation
Example: "One-time payroll load."

location

string | null

^([a-zA-Z0-9]{1,20})$

Unique location identifier (location) as returned by the Create Location endpoint. This value is also returned by the Get Locations endpoint depending on the value of locationType when the location was created:

0 or 2 — Returned in the location_id field
1 — Returned in the provider_specified_id field

Pattern: Integer if locationType: 0 or locationType: 2; max 15 characters if locationType: 1
Example: "a455-3483"

locationType

int32

enum

Defaults to 0

Type of ID in location:

0 — Galileo location ID
1 — Partner location ID
2 — Don't validate

Pattern: Integer
Example: 0

Allowed:

providerAssessedFee

float | null

-0.00001 to 999999999999.99

Fee amount assessed by the provider. This value is passed to Galileo only for informational purposes; passing this value does not assess the fee.
Pattern: Monetary amount greater than 0.
Example: 2.50

verifyOnly

int32 | null

enum

Pass 1 to test the endpoint data without creating a transaaction.
Pattern: Integer
Example: 0

Allowed:

merchantId

string | null

Load partners only. Identifier for the merchant that loaded the card.
Pattern: Max 50 alphanumeric characters
Example: "R12573L123"

partner

string | null

Load partners only. Partner providing the load request.
Pattern: Max 50 alphanumeric characters
Example: "CardLoader Inc"

retailChain

string | null

Load partners only. Name of the retail chain where the card was loaded.
Pattern: Max 50 alphanumeric characters
Example: "GroceryMart"

retailSaleTransactionKey

string | null

Load partners only. Identifier for the retail load transaction.
Pattern: Max 50 alphanumeric characters
Example: "12345abcdef"

storeAddress1

string | null

Load partners only. First line of the retail store address where the card was loaded.
Pattern: 4–40 alphanumeric characters
Example: 123 Elm St

storeAddress2

string | null

Load partners only. Second line of the retail store address where the card was loaded.
Pattern: Max 30 alphanumeric characters
Example: Ste 700

storeCounty

string | null

Load partners only. The country where the store is located. Three-digit UN M49 code, such as 840 for USA, 124 for Canada, 484 for Mexico, 170 for Colombia.
Pattern: 3-digit numeric string
Example: 840

storeLatitude

string | null

^([-+]?[0-9]{1,2}[.][0-9]+)$

Load partners only. Latitude for the retail store where the card was loaded.
Pattern: Positive or negative float, no limit on decimal places
Example: 40.57297941556069

storeLongitude

string | null

^([-+]?[0-9]{1,3}[.]\d+)$

Load partners only. Longitude for the retail store where the card was loaded.
Pattern: Positive or negative float, no limit on decimal places
Example: -111.89920138637734

storeName

string | null

Load partners only. Name of the retail store where the card was loaded.
Pattern: Max 50 alphanumeric characters
Example: "Main Street GroceryMart"

storeNumber

string | null

Load partners only. Identifier for the retail store where the card was loaded.
Pattern: Max 50 alphanumeric characters
Example: "13459284"

storeTransactionDate

date-time | null

Load partners only. Date that the card was loaded.
Pattern: YYYY-MM-DD hh:mm:ss
Example: 2021-11-14 13:23:04

storeCity

string | null

Load partners only. City for the retail store where the card was loaded.
Pattern: Max 30 letters and spaces
Example: Salt Lake City

storeState

string | null

Load partners only. State for the retail store where the card was loaded.
Pattern: 2-character state or province abbreviation
Example: UT

storeZipCode

string | null

^[a-zA-Z0-9\-\ ]*$

Load partners only. Zip code for the retail store where the card was loaded.
Pattern: 12345, 12345-1234, or K1A-1A1
Example: "84121"

holdAmount

float | null

0.01 to 999999999999.99

Amount to hold. To hold the entire payment amount, pass the same value as in amount.
Pattern: Positive integer or decimal number
Example: 100.00, 100, or 100.73

holdExpirationDateTime

date-time | null

Date-time to expire the hold.
Pattern: YYYY-MM-DD hh:mm:ss
Example: 2021-11-14 13:23:04

holdDescription

string | null

^([\w\W\s\d]{1,80})$

Description for the hold.
Pattern: Max 80 alphanumeric characters, including punctuation
Example: "One time payroll load."

holdExternalId

string | null

^[\w\W\s\d]{1,60}$

External identifier for a hold.
Pattern: Max 60 alphanumeric characters
Example: "45348bacd483348"

referenceId

string | null

^[\w\W\s\d]{1,35}$

Network identifier for RTP payments.
Pattern: Max 35 alphanumeric characters
Example: "20230805021000021P1BRJPM00040034610"

originatorName

string | null

Debtor (individual or company) name for RTP payments.
Pattern: Max 140 characters
Example: "John Doe"

receiverName

string | null

Creditor (individual or company) name for RTP payments.
Pattern: Max 140 characters
Example: "Jane Smith"

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

default