{
"recipient": {
"account": {
"iban": "<string>",
"accountNumber": "<string>",
"bankCode": "<string>",
"routingNumber": "<string>",
"reference": "<string>"
},
"customer": {
"reference": "<string>",
"name": "<string>",
"lastName": "<string>",
"email": "<string>",
"type": "<string>",
"birthDate": "2023-12-25",
"language": "<string>",
"identityCardNumber": "<string>",
"identityCardType": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"passwordChangedAt": "2023-11-07T05:31:56Z",
"previousPurchaseCount": 123,
"previousOrders": [
{
"purchasedAt": "2023-11-07T05:31:56Z",
"paymentMethod": "<string>",
"status": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"product": {},
"categoryId": "<string>",
"quantity": 123,
"id": "<string>",
"brand": "<string>",
"weight": 123,
"links": {
"productUrl": "<string>",
"imageUrl": "<string>"
},
"travelTicket": {
"ticketId": "<string>",
"passengers": [
{
"name": "<string>",
"lastName": "<string>",
"email": "<string>"
}
],
"routes": [
{
"legs": [
{
"legId": "<string>",
"departure": {
"city": "<string>",
"time": "2023-11-07T05:31:56Z"
},
"arrival": {
"city": "<string>",
"time": "2023-11-07T05:31:56Z"
}
}
]
}
]
}
}
]
}
]
},
"address": {
"street": "<string>",
"doorNumber": "<string>",
"complement": "<string>",
"area": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>",
"latitude": 123,
"longitude": 123,
"alias": "<string>",
"name": "<string>",
"lastName": "<string>",
"email": "<string>"
}
},
"sender": {
"customer": {
"reference": "<string>",
"name": "<string>",
"lastName": "<string>",
"email": "<string>",
"type": "<string>",
"birthDate": "2023-12-25",
"language": "<string>",
"identityCardNumber": "<string>",
"identityCardType": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"passwordChangedAt": "2023-11-07T05:31:56Z",
"previousPurchaseCount": 123,
"previousOrders": [
{
"purchasedAt": "2023-11-07T05:31:56Z",
"paymentMethod": "<string>",
"status": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"product": {},
"categoryId": "<string>",
"quantity": 123,
"id": "<string>",
"brand": "<string>",
"weight": 123,
"links": {
"productUrl": "<string>",
"imageUrl": "<string>"
},
"travelTicket": {
"ticketId": "<string>",
"passengers": [
{
"name": "<string>",
"lastName": "<string>",
"email": "<string>"
}
],
"routes": [
{
"legs": [
{
"legId": "<string>",
"departure": {
"city": "<string>",
"time": "2023-11-07T05:31:56Z"
},
"arrival": {
"city": "<string>",
"time": "2023-11-07T05:31:56Z"
}
}
]
}
]
}
}
]
}
]
},
"address": {
"street": "<string>",
"doorNumber": "<string>",
"complement": "<string>",
"area": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>",
"latitude": 123,
"longitude": 123,
"alias": "<string>",
"name": "<string>",
"lastName": "<string>",
"email": "<string>"
},
"companyName": "<string>"
}
}Funds Transfer
Every field of the meta order’s fundsTransfer for an Account Funding Transaction: the transfer type and purpose, and the sender and recipient details.
The order funds transfer details in case this is an AFT transaction.
The type of funds transfer.
disbursement, personToPerson, accountToAccount, topUp, purchase, cash, walletLoad A human-readable description of the purpose for the funds transfer.
donation, education, emergency, expatriation, familySupport, financialServices, gifts, income, insurance, investment, itServices, leisure, loanPayment, medical, business, crypto, assets, prepaid, crowdLending, debitCard, giftCard, gaming, highRiskSecurities, salary, pension, royalities, savings, travelAndTourism, other Details of the individual or entity receiving the funds.
Hide child attributes
Hide child attributes
The account details for the recipient.
Hide child attributes
Hide child attributes
The type of account.
bankAccount, card, wallet, storedValueWallet, stagedDigitalWallet, merchantWallet, email, phone, socialNetwork The identifier type for a bankAccount.
iban, swift, routingNumber IBAN for a bank account.
Account number for a bank account.
Bank code for a bank account. Can be a SWIFT/BIC or local code.
Routing number for a US domestic bank account.
Generic identifier for non-bank accounts. Used for card numbers, wallet IDs, email, or phone numbers.
The details of the recipient.
Hide child attributes
Hide child attributes
Customer reference number specified by the merchant. Defaults to holderReference of the execution if not specified.
The full name (or first name, if you can provide lastName separate) of the customer.
Last name of the customer (if required to be separate from name).
Email address of the customer.
Customer type specified by the merchant.
Phone of the customer.
Date of birth of the customer.
POSIX locale string identifying the language used to communicate to the customer.
^[a-z]{2}(_[A-Z]+)?$Country of registration the customer. Can be different than the order and delivery countries.
Hide child attributes
Hide child attributes
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.
^[A-Z]{3}$The English name of the country. Returned by Payrails, but not interpreted in requests.
The customer's identity number, e.g. passport, national ID, etc.
The type of the customer's identity card, e.g. passport, national ID, etc.
The customer's account creation date in RFC 3339 format. Required for Tabby integrations.
The customer's account last-updated date in RFC 3339 format.
The date the customer last changed their account password, in RFC 3339 format. Used as a 3-D Secure 2 risk signal: issuers treat a recent credential change as account-takeover risk.
Number of previous purchases the customer made with the merchant. Required for Tabby integrations.
The customer's previous orders with the merchant, used for order history based pre-scoring (e.g. BNPL providers). Required for Tabby integrations.
Hide child attributes
Hide child attributes
Date and time the order was purchased, in RFC 3339 format.
Amount of the previous order.
Hide child attributes
Hide child attributes
Payment method used for the previous order, e.g. card, cod.
Status of the previous order, e.g. complete, refunded, canceled.
List of details per item in the previous order (same shape as an order's lines).
Hide child attributes
Hide child attributes
The name of the item.
The description of the item.
Category identifier of the item on the merchant's system.
The type of the item. the line value will be added to the order total in case of lineItem, tax and subtracted from order total in case of discount.
lineItem, discount, tax How many instances of this item are part of the order.
How much does a unit of the item cost.
Hide child attributes
Hide child attributes
Decimal amount of the major currency unit. Can be any precision.
[0-9]+(\.[0-9]+)?"12.50"
ISO 3-letter currency code.
^[A-Z]{3}$"EUR"
Cost of unit price multiplied by quantity with the tax and discount applied.
Hide child attributes
Hide child attributes
Tax percentage that applies to the specific item, applicable only where item.type == lineItem, will be ignored when not providing item.unitPrice.
Hide child attributes
Hide child attributes
A percentage value up to 2 decimal precision.
^((100)|(\d{1,2}(\.\d*)?))$"12.50"
Tax code classifying the item for tax calculation.
businessSaas, consumerSaas, businessSaasSecurity, consumerSaasSecurity, businessSaasStorage, consumerSaasStorage, softwareOnprem, businessPaas, consumerPaas, businessIaas, consumerIaas, businessWebHosting, consumerWebHosting, businessDomainNames, consumerDomainNames, businessSoftwareDownload, consumerSoftwareDownload, businessSoftwareMaintenanceOptional, consumerSoftwareMaintenanceOptional, businessDigitalSubscription, consumerDigitalSubscription, businessGamingSubscription, consumerGamingSubscription, businessVideoSubscription, consumerVideoSubscription, businessPhotographySubscription, consumerPhotographySubscription, businessMusicSubscription, consumerMusicSubscription, businessEbookSubscription, consumerEbookSubscription, businessInAppSubscription, consumerInAppSubscription, businessDatasetSubscription, consumerDatasetSubscription, businessDigitalPermanent, consumerDigitalPermanent, businessGamingPermanent, consumerGamingPermanent, businessVideoPermanent, consumerVideoPermanent, businessPhotographyPermanent, consumerPhotographyPermanent, businessMusicPermanent, consumerMusicPermanent, businessNft, consumerNft, businessEbookPermanent, consumerEbookPermanent, businessInAppPermanent, consumerInAppPermanent, businessDatasetPermanent, consumerDatasetPermanent, businessDigitalAdvertising, consumerDigitalAdvertising, exempt The billing period this line covers, for a recurring/subscription charge. Omit for one-time line items.
The total discount applied on this item (quantity x discount per item), applicable only where item.type == lineItem, will be ignored when not providing item.unitPrice.
Hide child attributes
Hide child attributes
Decimal amount of the major currency unit. Can be any precision.
[0-9]+(\.[0-9]+)?"12.50"
ISO 3-letter currency code.
^[A-Z]{3}$"EUR"
The total tax added for this item (quantity x tax per item), applicable only where items.type = lineItem, will be ignored when not providing item.unitPrice.
Hide child attributes
Hide child attributes
Decimal amount of the major currency unit. Can be any precision.
[0-9]+(\.[0-9]+)?"12.50"
ISO 3-letter currency code.
^[A-Z]{3}$"EUR"
Identifier of the item on the merchant's system.
The manufacturer or brand name of the item.
The weight of the item, in kilograms.
Details about the travel ticket.
Hide child attributes
Hide child attributes
The ID of the travel ticket.
The passengers on the travel ticket.
Hide child attributes
Hide child attributes
The name of the passenger.
The last name of the passenger.
The phone number of the passenger.
Hide child attributes
Hide child attributes
The local number of the phone, such that countryCode + number can be dialed.
^[0-9]+$International prefix of the phone, if known separately.
^\+?[0-9]+$The type of the passenger.
adult, child, infant, senior The email of the passenger.
The routes on the travel ticket.
Hide child attributes
Hide child attributes
The legs on the route.
Hide child attributes
Hide child attributes
The ID of the leg.
A point on a travel ticket leg.
Hide child attributes
Hide child attributes
The city of the point.
The country of the point.
Hide child attributes
Hide child attributes
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.
^[A-Z]{3}$The English name of the country. Returned by Payrails, but not interpreted in requests.
The time of the point.
A point on a travel ticket leg.
Hide child attributes
Hide child attributes
The city of the point.
The country of the point.
Hide child attributes
Hide child attributes
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.
^[A-Z]{3}$The English name of the country. Returned by Payrails, but not interpreted in requests.
The time of the point.
The physical address of the recipient.
Hide child attributes
Hide child attributes
The name of the street of a postal address.
The number on the door, building, or room.
Additional addressing information, 2nd line of postal address.
The name of the suburb or area within a city.
The name of the city of a postal address.
The postal code.
The name of the state a postal address is in.
The country where the address is in.
Hide child attributes
Hide child attributes
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.
^[A-Z]{3}$The English name of the country. Returned by Payrails, but not interpreted in requests.
Latitude of the address in the GPS coordinate system.
Longitude of the address in the GPS coordinate system.
The phone to contact in the address (can be different that the customer's).
Name of the address, e.g. home, work.
Name of the person to whom the address belongs to.
Last name of the person to whom the address belongs to.
Email of the person to whom the address belongs to.
Details of the individual or entity sending the funds.
Hide child attributes
Hide child attributes
The details of the sender.
Hide child attributes
Hide child attributes
Customer reference number specified by the merchant. Defaults to holderReference of the execution if not specified.
The full name (or first name, if you can provide lastName separate) of the customer.
Last name of the customer (if required to be separate from name).
Email address of the customer.
Customer type specified by the merchant.
Date of birth of the customer.
POSIX locale string identifying the language used to communicate to the customer.
^[a-z]{2}(_[A-Z]+)?$Country of registration the customer. Can be different than the order and delivery countries.
Hide child attributes
Hide child attributes
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.
^[A-Z]{3}$The English name of the country. Returned by Payrails, but not interpreted in requests.
The customer's identity number, e.g. passport, national ID, etc.
The type of the customer's identity card, e.g. passport, national ID, etc.
The customer's account creation date in RFC 3339 format. Required for Tabby integrations.
The customer's account last-updated date in RFC 3339 format.
The date the customer last changed their account password, in RFC 3339 format. Used as a 3-D Secure 2 risk signal: issuers treat a recent credential change as account-takeover risk.
Number of previous purchases the customer made with the merchant. Required for Tabby integrations.
The customer's previous orders with the merchant, used for order history based pre-scoring (e.g. BNPL providers). Required for Tabby integrations.
Hide child attributes
Hide child attributes
Date and time the order was purchased, in RFC 3339 format.
Amount of the previous order.
Hide child attributes
Hide child attributes
Payment method used for the previous order, e.g. card, cod.
Status of the previous order, e.g. complete, refunded, canceled.
List of details per item in the previous order (same shape as an order's lines).
Hide child attributes
Hide child attributes
The name of the item.
The description of the item.
Category identifier of the item on the merchant's system.
The type of the item. the line value will be added to the order total in case of lineItem, tax and subtracted from order total in case of discount.
lineItem, discount, tax How many instances of this item are part of the order.
How much does a unit of the item cost.
Hide child attributes
Hide child attributes
Decimal amount of the major currency unit. Can be any precision.
[0-9]+(\.[0-9]+)?"12.50"
ISO 3-letter currency code.
^[A-Z]{3}$"EUR"
Cost of unit price multiplied by quantity with the tax and discount applied.
Hide child attributes
Hide child attributes
Tax percentage that applies to the specific item, applicable only where item.type == lineItem, will be ignored when not providing item.unitPrice.
Hide child attributes
Hide child attributes
A percentage value up to 2 decimal precision.
^((100)|(\d{1,2}(\.\d*)?))$"12.50"
Tax code classifying the item for tax calculation.
businessSaas, consumerSaas, businessSaasSecurity, consumerSaasSecurity, businessSaasStorage, consumerSaasStorage, softwareOnprem, businessPaas, consumerPaas, businessIaas, consumerIaas, businessWebHosting, consumerWebHosting, businessDomainNames, consumerDomainNames, businessSoftwareDownload, consumerSoftwareDownload, businessSoftwareMaintenanceOptional, consumerSoftwareMaintenanceOptional, businessDigitalSubscription, consumerDigitalSubscription, businessGamingSubscription, consumerGamingSubscription, businessVideoSubscription, consumerVideoSubscription, businessPhotographySubscription, consumerPhotographySubscription, businessMusicSubscription, consumerMusicSubscription, businessEbookSubscription, consumerEbookSubscription, businessInAppSubscription, consumerInAppSubscription, businessDatasetSubscription, consumerDatasetSubscription, businessDigitalPermanent, consumerDigitalPermanent, businessGamingPermanent, consumerGamingPermanent, businessVideoPermanent, consumerVideoPermanent, businessPhotographyPermanent, consumerPhotographyPermanent, businessMusicPermanent, consumerMusicPermanent, businessNft, consumerNft, businessEbookPermanent, consumerEbookPermanent, businessInAppPermanent, consumerInAppPermanent, businessDatasetPermanent, consumerDatasetPermanent, businessDigitalAdvertising, consumerDigitalAdvertising, exempt The billing period this line covers, for a recurring/subscription charge. Omit for one-time line items.
The total discount applied on this item (quantity x discount per item), applicable only where item.type == lineItem, will be ignored when not providing item.unitPrice.
Hide child attributes
Hide child attributes
Decimal amount of the major currency unit. Can be any precision.
[0-9]+(\.[0-9]+)?"12.50"
ISO 3-letter currency code.
^[A-Z]{3}$"EUR"
The total tax added for this item (quantity x tax per item), applicable only where items.type = lineItem, will be ignored when not providing item.unitPrice.
Hide child attributes
Hide child attributes
Identifier of the item on the merchant's system.
The manufacturer or brand name of the item.
The weight of the item, in kilograms.
Details about the travel ticket.
Hide child attributes
Hide child attributes
The ID of the travel ticket.
The passengers on the travel ticket.
Hide child attributes
Hide child attributes
The name of the passenger.
The last name of the passenger.
The phone number of the passenger.
Hide child attributes
Hide child attributes
The local number of the phone, such that countryCode + number can be dialed.
^[0-9]+$International prefix of the phone, if known separately.
^\+?[0-9]+$The type of the passenger.
adult, child, infant, senior The email of the passenger.
The routes on the travel ticket.
Hide child attributes
Hide child attributes
The legs on the route.
Hide child attributes
Hide child attributes
The ID of the leg.
A point on a travel ticket leg.
Hide child attributes
Hide child attributes
The city of the point.
The country of the point.
Hide child attributes
Hide child attributes
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.
^[A-Z]{3}$The English name of the country. Returned by Payrails, but not interpreted in requests.
The time of the point.
A point on a travel ticket leg.
Hide child attributes
Hide child attributes
The city of the point.
The country of the point.
Hide child attributes
Hide child attributes
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.
^[A-Z]{3}$The English name of the country. Returned by Payrails, but not interpreted in requests.
The time of the point.
The physical address of the sender.
Hide child attributes
Hide child attributes
The name of the street of a postal address.
The number on the door, building, or room.
Additional addressing information, 2nd line of postal address.
The name of the suburb or area within a city.
The name of the city of a postal address.
The postal code.
The name of the state a postal address is in.
The country where the address is in.
Hide child attributes
Hide child attributes
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.
^[A-Z]{3}$The English name of the country. Returned by Payrails, but not interpreted in requests.
Latitude of the address in the GPS coordinate system.
Longitude of the address in the GPS coordinate system.
The phone to contact in the address (can be different that the customer's).
Name of the address, e.g. home, work.
Name of the person to whom the address belongs to.
Last name of the person to whom the address belongs to.
Email of the person to whom the address belongs to.
The type of sender.
individual, corporate, instrument The sender's company name, if applicable.