Orders (2)

API Version v2

An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders.

Create order

post/v2/checkout/orders

Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.

Note: For error handling and troubleshooting, see Orders v2 errors.

SecurityOauth2
Request
header Parameters
PayPal-Request-Id
string [ 1 .. 108 ] characters

The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).

PayPal-Partner-Attribution-Id
string [ 1 .. 36 ] characters
PayPal-Client-Metadata-Id
string [ 1 .. 36 ] characters
Prefer
string [ 1 .. 25 ] characters ^[a-zA-Z=,-]*$
Default: return=minimal

The preferred server response upon successful completion of the request. Value is:

  • return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.
  • return=representation. The server returns a complete resource representation, including the current state of the resource.

PayPal-Auth-Assertion
string

An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.

Request Body schema:
required
required
Array of objects (Purchase Unit Request) [ 1 .. 10 ] items

An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.

intent
required
string (checkout_payment_intent)

The intent to either capture payment immediately or authorize a payment for an order after order creation.

Enum Value Description
CAPTURE

The merchant intends to capture payment immediately after the customer makes a payment.

AUTHORIZE

The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one purchase_unit within your order.

object <payer_v1> (payer)

DEPRECATED. The customer is also known as the payer. The Payer object was intended to only be used with the payment_source.paypal object. In order to make this design more clear, the details in the payer object are now available under payment_source.paypal. Please use payment_source.paypal.

object (payment_source)

The payment source definition.

object (application_context)

Customize the payer experience during the approval process for the payment with PayPal.

Responses
200

A successful response to an idempotent request returns the HTTP 200 OK status code with a JSON response body that shows order details.

201

A successful request returns the HTTP 201 Created status code and a JSON response body that includes by default a minimal response with the ID, status, and HATEOAS links. If you require the complete order resource representation, you must pass the Prefer: return=representation request header. This header value is not the default.

400

Request is not well-formed, syntactically incorrect, or violates schema.

422

The requested action could not be performed, semantically incorrect, or failed business validation.

Request samples 
Response samples 
application/json
{}
Show order details
get/v2/checkout/orders/{id}
Shows details for an order, by ID.
Note: For error handling and troubleshooting, see Orders v2 errors.


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order for which to show details.


 
query Parameters
fields
string^[a-z_]*$
A comma-separated list of fields that should be returned for the order. Valid filter field is payment_source.


 
header Parameters
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.


 
Responses 
200
A successful request returns the HTTP 200 OK status code and a JSON response body that shows order details.


404
The specified resource does not exist.


Request samples 
Response samples 
application/json
{}
Update order
patch/v2/checkout/orders/{id}
Updates an order with a CREATED or APPROVED status. You cannot update an order with the COMPLETED status.

To make an update, you must provide a reference_id. If you omit this value with an order that contains only one purchase unit, PayPal sets the value to default which enables you to use the path: "/purchase_units/@reference_id=='default'/{attribute-or-object}". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.
Note: For error handling and troubleshooting, see Orders v2 errors.
Patchable attributes or objects:

AttributeOpNotes
intentreplace
payerreplace, addUsing replace op for payer will replace the whole payer object with the value sent in request.
purchase_unitsreplace, add
purchase_units[].custom_idreplace, add, remove
purchase_units[].descriptionreplace, add, remove
purchase_units[].payee.emailreplace
purchase_units[].shipping.namereplace, add
purchase_units[].shipping.email_addressreplace, add
purchase_units[].shipping.phone_numberreplace, add
purchase_units[].shipping.optionsreplace, add
purchase_units[].shipping.addressreplace, add
purchase_units[].shipping.typereplace, add
purchase_units[].soft_descriptorreplace, remove
purchase_units[].amountreplace
purchase_units[].itemsreplace, add, remove
purchase_units[].invoice_idreplace, add, remove
purchase_units[].payment_instructionreplace
purchase_units[].payment_instruction.disbursement_modereplaceBy default, disbursement_mode is INSTANT.
purchase_units[].payment_instruction.payee_receivable_fx_rate_idreplace, add, remove
purchase_units[].payment_instruction.platform_feesreplace, add, remove
purchase_units[].supplementary_data.airlinereplace, add, remove
purchase_units[].supplementary_data.cardreplace, add, remove
application_context.client_configurationreplace, add


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order to update.


 
header Parameters
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.


 
Request Body schema: application/json
 Array ([ 0 .. 32767 ] items)
op
required
string
The operation.


 Enum Value Description
add
Depending on the target location reference, completes one of these functions:
  • The target location is an array index. Inserts a new value into the array at the specified index.
  • The target location is an object parameter that does not already exist. Adds a new parameter to the object.
  • The target location is an object parameter that does exist. Replaces that parameter's value.
The value parameter defines the value to add. For more information, see 4.1. add.


remove
Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.


replace
Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.


move
Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move.


copy
Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy.


test
Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:
TypeConsidered equal if both values
stringsContain the same number of Unicode characters and their code points are byte-by-byte equal.
numbersAre numerically equal.
arraysContain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
objectsContain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
literals (false, true, and null)Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.
For more information, see 4.6. test.


 
path
string
The JSON Pointer to the target document location at which to complete the operation.


 
value
any (Patch Value) 
The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified.


 
from
string
The JSON Pointer to the target document location from which to move the value. Required for the move operation.


 
Responses 
204
A successful request returns the HTTP 204 No Content status code with an empty object in the JSON response body.


400
Request is not well-formed, syntactically incorrect, or violates schema.


422
The requested action could not be performed, semantically incorrect, or failed business validation.


Request samples 
Response samples 
application/json
{ }
Confirm the Order
post/v2/checkout/orders/{id}/confirm-payment-source
Payer confirms their intent to pay for the the Order with the given payment source.


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order for which the payer confirms their intent to pay.


 
header Parameters
PayPal-Client-Metadata-Id
string  [ 1 .. 36 ] characters 
 
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.


 
Prefer
string  [ 1 .. 25 ] characters ^[a-zA-Z=]*$
 Default:  return=minimal
The preferred server response upon successful completion of the request. Value is:
  • return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.
  • return=representation. The server returns a complete resource representation, including the current state of the resource.


 
Request Body schema: 
object (Order Confirm Application Context) 
Customizes the payer confirmation experience.


 
required
object (payment_source) 
The payment source definition.


 
Responses 
200
A successful request indicates that the payment source was added to the Order. A successful request returns the HTTP 200 OK status code with a JSON response body that shows order details.


400
Request is not well-formed, syntactically incorrect, or violates schema.


403
Authorization failed due to insufficient permissions.


404
Default description


422
The requested action could not be performed, semantically incorrect, or failed business validation.


500
An internal server error has occurred.


Request samples 
Response samples 
application/json
{}
Authorize payment for order
post/v2/checkout/orders/{id}/authorize
Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.
Note: For error handling and troubleshooting, see Orders v2 errors.


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order for which to authorize.


 
header Parameters
PayPal-Request-Id
string  [ 1 .. 108 ] characters 
The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).


 
Prefer
string  [ 1 .. 25 ] characters ^[a-zA-Z=,-]*$
 Default:  return=minimal
The preferred server response upon successful completion of the request. Value is:
  • return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.
  • return=representation. The server returns a complete resource representation, including the current state of the resource.


 
PayPal-Client-Metadata-Id
string  [ 1 .. 36 ] characters 
 
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.


 
Request Body schema: 
object (payment_source) 
The source of payment for the order, which can be a token or a card. Use this object only if you have not redirected the user after order creation to approve the payment. In such cases, the user-selected payment method in the PayPal flow is implicitly used.


 
Responses 
200
A successful response to an idempotent request returns the HTTP 200 OK status code with a JSON response body that shows authorized payment details.


201
A successful response to a non-idempotent request returns the HTTP 201 Created status code with a JSON response body that shows authorized payment details. If a duplicate response is retried, returns the HTTP 200 OK status code. By default, the response is minimal. If you need the complete resource representation, you must pass the Prefer: return=representation request header.


403
The authorized payment failed due to insufficient permissions.


422
The requested action could not be performed, semantically incorrect, or failed business validation.


Request samples 
Response samples 
application/json
{}
Capture payment for order
post/v2/checkout/orders/{id}/capture
Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.
Note: For error handling and troubleshooting, see Orders v2 errors.


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order for which to capture a payment.


 
header Parameters
PayPal-Request-Id
string  [ 1 .. 108 ] characters 
The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).


 
Prefer
string  [ 1 .. 25 ] characters ^[a-zA-Z=,-]*$
 Default:  return=minimal
The preferred server response upon successful completion of the request. Value is:
  • return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.
  • return=representation. The server returns a complete resource representation, including the current state of the resource.


 
PayPal-Client-Metadata-Id
string  [ 1 .. 36 ] characters 
 
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.


 
Request Body schema: 
object (payment_source) 
The payment source definition.


 
Responses 
200
A successful response to an idempotent request returns the HTTP 200 OK status code with a JSON response body that shows captured payment details.


201
A successful response to a non-idempotent request returns the HTTP 201 Created status code with a JSON response body that shows captured payment details. If a duplicate response is retried, returns the HTTP 200 OK status code. By default, the response is minimal. If you need the complete resource representation, pass the Prefer: return=representation request header.


403
The authorized payment failed due to insufficient permissions.


404
The specified resource does not exist.


422
The requested action could not be performed, semantically incorrect, or failed business validation.


Request samples 
Response samples 
application/json
{
  • "id": "5O190127TN364715T",
  • "status": "COMPLETED",
  • "payment_source": {
    • "paypal": {
      • "name": {
        • "given_name": "John",
        • "surname": "Doe"
        },
      • "email_address": "customer@example.com",
      • "account_id": "QYR5Z8XDVJNXQ",
      • "account_status": "VERIFIED"
      }
    },
  • "purchase_units": [
    • {
      • "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
      • "shipping": {
        • "address": {
          • "address_line_1": "2211 N First Street",
          • "address_line_2": "Building 17",
          • "admin_area_2": "San Jose",
          • "admin_area_1": "CA",
          • "postal_code": "95131",
          • "country_code": "US"
          }
        },
      • "payments": {
        • "captures": [
          • {
            • "id": "3C679366HH908993F",
            • "status": "COMPLETED",
            • "amount": {
              • "currency_code": "USD",
              • "value": "100.00"
              },
            • "seller_protection": {
              • "status": "ELIGIBLE",
              • "dispute_categories": [
                • "ITEM_NOT_RECEIVED",
                • "UNAUTHORIZED_TRANSACTION"
                ]
              },
            • "final_capture": true,
            • "disbursement_mode": "INSTANT",
            • "seller_receivable_breakdown": {
              • "gross_amount": {
                • "currency_code": "USD",
                • "value": "100.00"
                },
              • "paypal_fee": {
                • "currency_code": "USD",
                • "value": "3.00"
                },
              • "net_amount": {
                • "currency_code": "USD",
                • "value": "97.00"
                }
              },
            • "create_time": "2018-04-01T21:20:49Z",
            • "update_time": "2018-04-01T21:20:49Z",
            • "links": []
            }
          ]
        }
      }
    ],
  • "payer": {
    • "name": {
      • "given_name": "John",
      • "surname": "Doe"
      },
    • "email_address": "customer@example.com",
    • "payer_id": "QYR5Z8XDVJNXQ"
    },
  • "links": []
}
Add tracking information for an Order.
post/v2/checkout/orders/{id}/track
Adds tracking information for an Order.


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order that the tracking information is associated with.


 
header Parameters
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.


 
Request Body schema: 
required
tracking_number
required
string  [ 1 .. 64 ] characters 
The tracking number for the shipment. This property supports Unicode.


 
carrier_name_other
string  [ 1 .. 64 ] characters 
The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.


 
carrier
required
string (carrier)   [ 1 .. 64 ] characters ^[0-9A-Z_]+$
The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier to OTHER and set carrier name in carrier_name_other. For allowed values, see Carriers.


 Enum Value Description
DPD_RU
DPD Russia.


BG_BULGARIAN_POST
Bulgarian Posts.


KR_KOREA_POST
Koreapost (www.koreapost.go.kr).


ZA_COURIERIT
Courier IT.


FR_EXAPAQ
DPD France (formerly exapaq).


ARE_EMIRATES_POST
Emirates Post.


GAC
GAC.


GEIS
Geis CZ.


SF_EX
SF Express.


PAGO
Pago Logistics.


MYHERMES
MyHermes UK.


DIAMOND_EUROGISTICS
Diamond Eurogistics Limited.


CORPORATECOURIERS_WEBHOOK
Corporate Couriers.


BOND
Bond courier.


OMNIPARCEL
Omni Parcel.


SK_POSTA
Slovenska pošta.


PUROLATOR
purolator.


FETCHR_WEBHOOK
Mena 360 (Fetchr).


THEDELIVERYGROUP
TDG – The Delivery Group.


CELLO_SQUARE
Cello Square.


TARRIVE
TONDA GLOBAL.


COLLIVERY
MDS Collivery Pty (Ltd).


MAINFREIGHT
Mainfreight.


IND_FIRSTFLIGHT
First Flight Couriers.


ACSWORLDWIDE
ACS Worldwide Express.


AMSTAN
Amstan Logistics.


OKAYPARCEL
OkayParcel.


ENVIALIA_REFERENCE
Envialia Reference.


SEUR_ES
Seur Spain.


CONTINENTAL
Continental.


FDSEXPRESS
FDSEXPRESS.


AMAZON_FBA_SWISHIP
Swiship UK.


WYNGS
Wyngs.


DHL_ACTIVE_TRACING
DHL Active Tracing.


ZYLLEM
Zyllem.


RUSTON
Ruston.


XPOST
Xpost.ph.


CORREOS_ES
correos Express (www.correos.es).


DHL_FR
DHL France (www.dhl.com).


PAN_ASIA
Pan-Asia International.


BRT_IT
BRT couriers Italy (www.brt.it).


SRE_KOREA
SRE Korea (www.srekorea.co.kr).


SPEEDEE
Spee-Dee Delivery.


TNT_UK
TNT UK Limited (www.tnt.com).


VENIPAK
Venipak.


SHREENANDANCOURIER
SHREE NANDAN COURIER.


CROSHOT
Croshot.


NIPOST_NG
NIpost (www.nipost.gov.ng).


EPST_GLBL
ePost Global.


NEWGISTICS
Newgistics.


POST_SLOVENIA
Post of Slovenia.


JERSEY_POST
Jersey Post.


BOMBINOEXP
Bombino Express Pvt.


WMG
WMG Delivery.


XQ_EXPRESS
XQ Express.


FURDECO
Furdeco.


LHT_EXPRESS
LHT Express.


SOUTH_AFRICAN_POST_OFFICE
South African Post Office.


SPOTON
SPOTON Logistics Pvt Ltd.


DIMERCO
Dimerco Express Group.


CYPRUS_POST_CYP
cyprus post.


ABCUSTOM
AB Custom Group.


IND_DELIVREE
deliverE.


CN_BESTEXPRESS
Best Express.


DX_SFTP
DX (SFTP).


PICKUPP_MYS
PICK UPP.


FMX
FMX.


HELLMANN
Hellmann Worldwide Logistics.


SHIP_IT_ASIA
Ship It Asia.


KERRY_ECOMMERCE
Kerry eCommerce.


FRETERAPIDO
Frete Rapido.


PITNEY_BOWES
Pitney Bowes.


XPRESSEN_DK
Xpressen courier.


SEUR_SP_API
Spanish Seur API.


DELIVERYONTIME
DELIVERYONTIME LOGISTICS PVT LTD.


JINSUNG
JINSUNG TRADING.


TRANS_KARGO
Trans Kargo Internasional.


SWISHIP_DE
Swiship DE.


IVOY_WEBHOOK
Ivoy courier.


AIRMEE_WEBHOOK
Airmee couriers.


DHL_BENELUX
dhl benelux.


FIRSTMILE
FirstMile.


FASTWAY_IR
Fastway Ireland.


HH_EXP
Hua Han Logistics.


MYS_MYPOST_ONLINE
Mypostonline.


TNT_NL
THT Netherland.


TIPSA
TIPSA courier.


TAQBIN_MY
TAQBIN Malaysia.


KGMHUB
KGM Hub.


INTEXPRESS
Internet Express.


OVERSE_EXP
Overseas Express.


ONECLICK
One click delivery services.


ROADRUNNER_FREIGHT
Roadbull Logistics.


GLS_CROTIA
GLS Croatia.


MRW_FTP
MRW courier.


BLUEX
Blue Express.


DYLT
Daylight Transport.


DPD_IR
DPD Ireland.


SIN_GLBL
Sin Global Express.


TUFFNELLS_REFERENCE
Tuffnells Parcels Express- Reference.


CJPACKET
CJ Packet.


MILKMAN
Milkman courier.


ASIGNA
ASIGNA courier.


ONEWORLDEXPRESS
One World Express.


ROYAL_MAIL
RoyalShipments.


VIA_EXPRESS
Viaxpress.


TIGFREIGHT
TIG Freight.


ZTO_EXPRESS
ZTO Express.


TWO_GO
2GO Courier.


IML
IML courier.


INTEL_VALLEY
Intel-Valley Supply chain (ShenZhen) Co. Ltd.


EFS
EFS (E-commerce Fulfillment Service).


UK_UK_MAIL
UK mail (ukmail.com).


RAM
RAM courier.


ALLIEDEXPRESS
Allied Express.


APC_OVERNIGHT
APC overnight (apc-overnight.com).


SHIPPIT
Shippit.


TFM
TFM Xpress.


M_XPRESS
M Xpress Sdn Bhd.


HDB_BOX
Haidaibao (BOX).


CLEVY_LINKS
Clevy Links.


IBEONE
Beone Logistics.


FIEGE_NL
Fiege Netherlands.


KWE_GLOBAL
KWE Global.


CTC_EXPRESS
CTC Express.


AMAZON
Amazon Shipping.


MORE_LINK
Morelink.


JX
JX courier.


EASY_MAIL
Easy Mail.


ADUIEPYLE
A Duie Pyle.


GB_PANTHER
Panther.


EXPRESSSALE
Expresssale.


SG_DETRACK
Detrack.


TRUNKRS_WEBHOOK
Trunkrs courier.


MATDESPATCH
Matdespatch.


DICOM
GLS Logistic Systems Canada Ltd./Dicom.


MBW
MBW Courier Inc..


KHM_CAMBODIA_POST
Cambodia Post.


SINOTRANS
Sinotrans.


BRT_IT_PARCELID
BRT Bartolini(Parcel ID).


DHL_SUPPLY_CHAIN
DHL Supply Chain APAC.


DHL_PL
DHL Poland.


TOPYOU
TopYou.


PALEXPRESS
PAL Express Limited.


DHL_SG
dhl Singapore.


CN_WEDO
WeDo Logistics.


FULFILLME
Fulfillme.


DPD_DELISTRACK
DPD delistrack.


UPS_REFERENCE
UPS Reference.


CARIBOU
Caribou.


LOCUS_WEBHOOK
Locus courier.


DSV
DSV courier.


P2P_TRC
P2P TrakPak.


DIRECTPARCELS
Direct Parcels.


NOVA_POSHTA_INT
Nova Poshta (International).


FEDEX_POLAND
FedEx® Poland Domestic.


CN_JCEX
JCEX courier.


FAR_INTERNATIONAL
FAR international.


IDEXPRESS
IDEX courier.


GANGBAO
GANGBAO Supplychain.


NEWAY
Neway Transport.


POSTNL_INT_3_S
PostNL International.


RPX_ID
RPX Indonesia.


DESIGNERTRANSPORT_WEBHOOK
Designer Transport.


GLS_SLOVEN
GLS Slovenia.


PARCELLED_IN
Parcelled.in.


GSI_EXPRESS
GSI EXPRESS.


CON_WAY
Con-way Freight.


BROUWER_TRANSPORT
Brouwer Transport en Logistiek.


CPEX
Captain Express International.


ISRAEL_POST
Israel Post.


DTDC_IN
DTDC India.


PTT_POST
PTT Post.


XDE_WEBHOOK
Ximex Delivery Express.


TOLOS
Tolos courier.


GIAO_HANG
Giao hàng nhanh.


GEODIS_ESPACE
Geodis E-space.


MAGYAR_HU
Magyar Post.


DOORDASH_WEBHOOK
DoorDash.


TIKI_ID
Tiki shipment.


CJ_HK_INTERNATIONAL
CJ Logistics International(Hong Kong).


STAR_TRACK_EXPRESS
Star Track Express.


HELTHJEM
Helthjem.


SFB2C
SF International.


FREIGHTQUOTE
Freightquote by C.H. Robinson.


LANDMARK_GLOBAL_REFERENCE
Landmark Global Reference.


PARCEL2GO
Parcel2Go.


DELNEXT
Delnext.


RCL
Red Carpet Logistics.


CGS_EXPRESS
CGS Express.


HK_POST
Hongkong Post (www.hongkongpost.hk).


SAP_EXPRESS
SAP EXPRESS.


PARCELPOST_SG
Parcel Post Singapore.


HERMES
HermesWorld UK.


IND_SAFEEXPRESS
Safexpress.


TOPHATTEREXPRESS
Tophatter Express.


MGLOBAL
PT MGLOBAL LOGISTICS INDONESIA.


AVERITT
Averitt Express.


LEADER
leader.


_2EBOX
2ebox courier.


SG_SPEEDPOST
Singapore Speedpost.


DBSCHENKER_SE
DB Schenker (www.dbschenker.com).


ISR_POST_DOMESTIC
Israel Post Domestic.


BESTWAYPARCEL
Best Way Parcel.


ASENDIA_DE
asendia_de.


NIGHTLINE_UK
nightline_uk.


TAQBIN_SG
taqbin_sg.


TCK_EXPRESS
TCK Express.


ENDEAVOUR_DELIVERY
Endeavour Delivery.


NANJINGWOYUAN
Nanjing Woyuan.


HEPPNER_FR
Heppner France.


EMPS_CN
EMPS Express.


FONSEN
Fonsen Logistics.


PICKRR
Pickrr.


APC_OVERNIGHT_CONNUM
APC Overnight Consignment.


STAR_TRACK_NEXT_FLIGHT
Star Track Next Flight.


DAJIN
Shanghai Aqrum Chemical Logistics Co.Ltd.


UPS_FREIGHT
UPS Freight.


POSTA_PLUS
Posta Plus.


CEVA
CEVA LOGISTICS.


ANSERX
ANSERX courier.


JS_EXPRESS
JS EXPRESS.


PADTF
padtf.com.


UPS_MAIL_INNOVATIONS
UPS Mail Innovations.


SYPOST
Sunyou Post.


AMAZON_SHIP_MCF
Amazon Shipping + Amazon MCF.


YUSEN
Yusen Logistics.


BRING
Bring.


SDA_IT
SDA Italy.


GBA
GBA Services Ltd.


NEWEGGEXPRESS
Newegg Express.


SPEEDCOURIERS_GR
Speed Couriers.


FORRUN
forrun Pvt Ltd (Arpatech Venture).


PICKUP
Pickupp.


ECMS
ECMS International Logistics Co..


INTELIPOST
Intelipost (TMS for LATAM).


FLASHEXPRESS
Flash Express.


CN_STO
STO Express.


SEKO_SFTP
SEKO Worldwide.


HOME_DELIVERY_SOLUTIONS
Home Delivery Solutions Ltd.


DPD_HGRY
DPD Hungary.


KERRYTTC_VN
Kerry Express (Vietnam) Co Ltd.


JOYING_BOX
Joying Box.


TOTAL_EXPRESS
Total Express.


ZJS_EXPRESS
ZJS International.


STARKEN
STARKEN couriers.


DEMANDSHIP
DemandShip.


CN_DPEX
DPEX.


AUPOST_CN
AuPost China.


LOGISTERS
Logisters.


GOGLOBALPOST
Global Post.


GLS_CZ
GLS Czech Republic.


PAACK_WEBHOOK
Paack courier.


GRAB_WEBHOOK
Grab courier.


PARCELPOINT
Parcelpoint.


ICUMULUS
iCumulus.


DAIGLOBALTRACK
DAI Post.


GLOBAL_IPARCEL
i-parcel.


YURTICI_KARGO
Yurtici Kargo.


CN_PAYPAL_PACKAGE
PayPal Package.


PARCEL_2_POST
Parcel To Post.


GLS_IT
GLS Italy.


PIL_LOGISTICS
PIL Logistics (China) Co..


HEPPNER
Heppner Internationale Spedition GmbH & Co..


GENERAL_OVERNIGHT
Go!Express and logistics.


HAPPY2POINT
Happy 2ThePoint.


CHITCHATS
Chit Chats.


SMOOTH
Smooth Couriers.


CLE_LOGISTICS
CL E-Logistics Solutions Limited.


FIEGE
Fiege Logistics.


MX_CARGO
M&X cargo.


ZIINGFINALMILE
Ziing Final Mile Inc.


DAYTON_FREIGHT
Dayton Freight.


TCS
TCS courier.


AEX
AEX Group.


HERMES_DE
Hermes Germany.


ROUTIFIC_WEBHOOK
Routific.


GLOBAVEND
Globavend.


CJ_LOGISTICS
CJ Logistics International.


PALLET_NETWORK
The Pallet Network.


RAF_PH
RAF Philippines.


UK_XDP
XDP Express.


PAPER_EXPRESS
Paper Express.


LA_POSTE_SUIVI
La Poste.


PAQUETEXPRESS
Paquetexpress.


LIEFERY
liefery.


STRECK_TRANSPORT
Streck Transport.


PONY_EXPRESS
Pony express.


ALWAYS_EXPRESS
Always Express.


GBS_BROKER
GBS-Broker.


CITYLINK_MY
City-Link Express.


ALLJOY
ALLJOY SUPPLY CHAIN.


YODEL
yodel.


YODEL_DIR
Yodel Direct.


STONE3PL
STONE3PL.


PARCELPAL_WEBHOOK
ParcelPal.


DHL_ECOMERCE_ASA
DHL eCommerce Asia (API).


SIMPLYPOST
J&T Express Singapore.


KY_EXPRESS
Kua Yue Express.


SHENZHEN
shenzhen 1st International Logistics(Group)Co.


US_LASERSHIP
LaserShip.


UC_EXPRE
ucexpress.


DIDADI
DIDADI Logistics tech.


CJ_KR
CJ Korea Express.


DBSCHENKER_B2B
DB Schenker B2B.


MXE
MXE Express.


CAE_DELIVERS
CAE Delivers.


PFCEXPRESS
PFC Express.


WHISTL
Whistl.


WEPOST
WePost Sdn Bhd.


DHL_PARCEL_ES
DHL parcel Spain(www.dhl.com).


DDEXPRESS
DD Express Courier.


ARAMEX_AU
Aramex Australia (formerly Fastway AU).


BNEED
Bneed courier.


HK_TGX
Kerry Express Hong Kong.


LATVIJAS_PASTS
Latvijas Pasts.


VIAEUROPE
ViaEurope.


CORREO_UY
Correo Uruguayo.


CHRONOPOST_FR
Chronopost france (www.chronopost.fr).


J_NET
J-Net.


_6LS
6ls.com.


BLR_BELPOST
Belpost.


BIRDSYSTEM
BirdSystem.


DOBROPOST
DobroPost.


WAHANA_ID
Wahana express (www.wahana.com).


WEASHIP
Weaship.


SONICTL
Sonic Transportation & Logistics.


KWT
Shenzhen Jinghuada Logistics Co..


AFLLOG_FTP
AFL LOGISTICS.


SKYNET_WORLDWIDE
SkyNet Worldwide Express.


NOVA_POSHTA
Nova Poshta (novaposhta.ua).


SEINO
Seino.


SZENDEX
SZENDEX.


BPOST_INT
Bpost international.


DBSCHENKER_SV
DB Schenker Sweden.


AO_DEUTSCHLAND
AO Deutschland.


EU_FLEET_SOLUTIONS
EU Fleet Solutions.


PCFCORP
PCF Final Mile.


LINKBRIDGE
Link Bridge(BeiJing)international logistics co..


PRIMAMULTICIPTA
PT Prima Multi Cipta.


COUREX
Urbanfox.


ZAJIL_EXPRESS
Zajil Express Company.


COLLECTCO
CollectCo.


JTEXPRESS
J&T EXPRESS MALAYSIA.


FEDEX_UK
FedEx® UK.


USHIP
uShip courier.


PIXSELL
PIXSELL LOGISTICS.


SHIPTOR
Shiptor.


CDEK
CDEK courier.


VNM_VIETTELPOST
ViettelPost.


CJ_CENTURY
CJ Century.


GSO
GSO(GLS-USA).


VIWO
VIWO IoT.


SKYBOX
SKYBOX.


KERRYTJ
Kerry TJ Logistics.


NTLOGISTICS_VN
Nhat Tin Logistics.


SDH_SCM
lightning monkey.


ZINC
Zinc courier.


DPE_SOUTH_AFRC
DPE South Africa.


CESKA_CZ
Czech Post.


ACS_GR
ACS Courier.


DEALERSEND
DealerSend.


JOCOM
Jocom.


CSE
CSE courier.


TFORCE_FINALMILE
TForce Final Mile.


SHIP_GATE
ShipGate.


SHIPTER
SHIPTER.


NATIONAL_SAMEDAY
National Sameday.


YUNEXPRESS
YunExpress.


CAINIAO
AliExpress Standard Shipping.


DMS_MATRIX
DMSMatrix.


DIRECTLOG
Directlog (www.directlog.com.br).


ASENDIA_US
Asendia USA.


_3JMSLOGISTICS
3JMS Logistics.


LICCARDI_EXPRESS
LICCARDI EXPRESS COURIER.


SKY_POSTAL
SkyPostal.


CNWANGTONG
cnwangtong.


POSTNORD_LOGISTICS_DK
ostnord denmark.


LOGISTIKA
Logistika.


CELERITAS
Celeritas Transporte.


PRESSIODE
Pressio.


SHREE_MARUTI
Shree Maruti Courier Services Pvt Ltd.


LOGISTICSWORLDWIDE_HK
Logistic Worldwide Express (LWE Honkong).


EFEX
eFEx (E-Commerce Fulfillment & Express).


LOTTE
Lotte Global Logistics.


LONESTAR
Lone Star Overnight.


APRISAEXPRESS
Aprisa Express.


BEL_RS
BEL North Russia.


OSM_WORLDWIDE
OSM Worldwide.


WESTGATE_GL
Westgate Global.


FASTRACK
Fasttrack.


DTD_EXPR
DTD Express.


ALFATREX
AlfaTrex.


PROMEDDELIVERY
ProMed Delivery.


THABIT_LOGISTICS
Thabit Logistics.


HCT_LOGISTICS
HCT LOGISTICS CO.LTD..


CARRY_FLAP
Carry-Flap Co..


US_OLD_DOMINION
Old Dominion Freight Line.


ANICAM_BOX
ANICAM BOX EXPRESS.


WANBEXPRESS
WanbExpress.


AN_POST
An Post.


DPD_LOCAL
DPD Local.


STALLIONEXPRESS
Stallion Express.


RAIDEREX
RaidereX.


SHOPFANS
ShopfansRU LLC.


KYUNGDONG_PARCEL
Kyungdong Parcel.


CHAMPION_LOGISTICS
Champion Logistics.


PICKUPP_SGP
PICK UPP (Singapore).


MORNING_EXPRESS
Morning Express.


NACEX
NACEX.


THENILE_WEBHOOK
SortHub courier.


HOLISOL
Holisol.


LBCEXPRESS_FTP
LBC EXPRESS INC..


KURASI
KURASI.


USF_REDDAWAY
USF Reddaway.


APG
APG eCommerce Solutions.


CN_BOXC
BoxC courier.


ECOSCOOTING
ECOSCOOTING.


MAINWAY
Mainway.


PAPERFLY
Paperfly Private Limited.


HOUNDEXPRESS
Hound Express.


BOX_BERRY
Boxberry courier.


EP_BOX
EP-Box courier.


PLUS_LOG_UK
Plus UK Logistics.


FULFILLA
Fulfilla.


ASE
ASE KARGO.


MAIL_PLUS
MailPlus.


XPO_LOGISTICS
XPO logistics.


WNDIRECT
wnDirect.


CLOUDWISH_ASIA
Cloudwish Asia.


ZELERIS
Zeleris.


GIO_EXPRESS
Gio Express.


OCS_WORLDWIDE
OCS WORLDWIDE.


ARK_LOGISTICS
ARK Logistics.


AQUILINE
Aquiline.


PILOT_FREIGHT
Pilot Freight Services.


QWINTRY
Qwintry Logistics.


DANSKE_FRAGT
Danske Fragtaend.


CARRIERS
Carriers courier.


AIR_CANADA_GLOBAL
Rivo (Air canada).


PRESIDENT_TRANS
PRESIDENT TRANSNET CORP.


STEPFORWARDFS
STEP FORWARD FREIGHT SERVICE CO LTD.


SKYNET_UK
Skynet UK.


PITTOHIO
PITT OHIO.


CORREOS_EXPRESS
Correos Express.


RL_US
RL Carriers.


DESTINY
Destiny Transportation.


UK_YODEL
Yodel (www.yodel.co.uk).


COMET_TECH
CometTech.


DHL_PARCEL_RU
DHL Parcel Russia.


TNT_REFR
TNT Reference.


SHREE_ANJANI_COURIER
Shree Anjani Courier.


MIKROPAKKET_BE
Mikropakket Belgium.


ETS_EXPRESS
RETS express.


COLIS_PRIVE
Colis Privé.


CN_YUNDA
Yunda Express.


AAA_COOPER
AAA Cooper.


ROCKET_PARCEL
Rocket Parcel International.


_360LION
360 Lion Express.


PANDU
PANDU.


PROFESSIONAL_COURIERS
PROFESSIONAL COURIERS.


FLYTEXPRESS
FLYTEXPRESS.


LOGISTICSWORLDWIDE_MY
LOGISTICSWORLDWIDE MY.


CORREOS_DE_ESPANA
CORREOS DE ESPANA.


IMX
IMX.


FOUR_PX_EXPRESS
FOUR PX EXPRESS.


XPRESSBEES
XPRESSBEES.


PICKUPP_VNM
pickupp_vnm.


STARTRACK_EXPRESS
startrack_express.


FR_COLISSIMO
fr_colissimo.


NACEX_SPAIN_REFERENCE
nacex_spain_reference.


DHL_SUPPLY_CHAIN_AU
dhl_supply_chain_au.


ESHIPPING
Eshipping.


SHREETIRUPATI
SHREE TIRUPATI COURIER SERVICES PVT. LTD..


HX_EXPRESS
HX Express.


INDOPAKET
INDOPAKET.


CN_17POST
17 Post Service.


K1_EXPRESS
K1 Express.


CJ_GLS
CJ GLS.


MYS_GDEX
GDEX courier.


NATIONEX
Nationex courier.


ANJUN
Anjun couriers.


FARGOOD
FarGood.


SMG_EXPRESS
SMG Direct.


RZYEXPRESS
RZY Express.


SEFL
Southeastern Freight Lines.


TNT_CLICK_IT
TNT-Click Italy.


HDB
Haidaibao.


HIPSHIPPER
Hipshipper.


RPXLOGISTICS
RPX Logistics.


KUEHNE
Kuehne + Nagel.


IT_NEXIVE
Nexive (TNT Post Italy).


PTS
PTS courier.


SWISS_POST_FTP
Swiss Post FTP.


FASTRK_SERV
Fastrak Services.


_4_72
4-72 Entregando.


US_YRC
YRC courier.


POSTNL_INTL_3S
PostNL International 3S.


ELIAN_POST
Yilian (Elian) Supply Chain.


CUBYN
Cubyn.


SAU_SAUDI_POST
Saudi Post.


ABXEXPRESS_MY
ABX Express.


HUAHAN_EXPRESS
HUAHANG EXPRESS.


ZES_EXPRESS
Eshun international Logistic.


ZEPTO_EXPRESS
ZeptoExpress.


SKYNET_ZA
Skynet World Wide Express South Africa.


ZEEK_2_DOOR
Zeek2Door.


BLINKLASTMILE
Blink.


POSTA_UKR
UkrPoshta.


CHROBINSON
C.H. Robinson Worldwide.


CN_POST56
Post56.


COURANT_PLUS
Courant Plus.


SCUDEX_EXPRESS
Scudex Express.


SHIPENTEGRA
ShipEntegra.


B_TWO_C_EUROPE
B2C courier Europe.


COPE
Cope Sensitive Freight.


IND_GATI
Gati-KWE.


CN_WISHPOST
WishPost.


NACEX_ES
NACEX Spain.


TAQBIN_HK
TAQBIN Hong Kong.


GLOBALTRANZ
GlobalTranz.


HKD
Qingdao HKD International Logistics.


BJSHOMEDELIVERY
BJS Distribution courier.


OMNIVA
Omniva.


SUTTON
Sutton Transport.


PANTHER_REFERENCE
Panther Reference.


SFCSERVICE
SFC Service.


LTL
LTL COURIER.


PARKNPARCEL
Park N Parcel.


SPRING_GDS
Spring GDS.


ECEXPRESS
ECexpress.


INTERPARCEL_AU
Interparcel Australia.


AGILITY
Agility.


XL_EXPRESS
XL Express.


ADERONLINE
Ader couriers.


DIRECTCOURIERS
Direct Couriers.


PLANZER
Planzer Group.


SENDING
Sending Transporte Urgente y Comunicacion.


NINJAVAN_WB
Ninjavan Webhook.


NATIONWIDE_MY
Nationwide Express Courier Services Bhd (www.nationwide.com.my).


SENDIT
Sendit.


GB_ARROW
Arrow XL.


IND_GOJAVAS
GoJavas.


KPOST
Korea Post.


DHL_FREIGHT
DHL Freight.


BLUECARE
Bluecare Express Ltd.


JINDOUYUN
jindouyun courier.


TRACKON
Trackon Couriers Pvt. Ltd.


GB_TUFFNELLS
Tuffnells Parcels Express.


TRUMPCARD
TRUMPCARD LLC.


ETOTAL
eTotal Solution Limited.


SFPLUS_WEBHOOK
Zeek courier.


SEKOLOGISTICS
SEKO Logistics.


HERMES_2MANN_HANDLING
Hermes Einrichtungs Service GmbH & Co. KG.


DPD_LOCAL_REF
DPD Local reference.


UDS
United Delivery Service.


ZA_SPECIALISED_FREIGHT
Specialised Freight.


THA_KERRY
Kerry Express Thailand.


PRT_INT_SEUR
SEUR International.


BRA_CORREIOS
Correios Brazil.


NZ_NZ_POST
New Zealand Post.


CN_EQUICK
Equick China.


MYS_EMS
Malaysia Post EMS / Pos Laju.


GB_NORSK
Norsk Global.


ESP_MRW
MRW spain.


ESP_PACKLINK
Packlink.


KANGAROO_MY
Kangaroo Worldwide Express.


RPX
RPX Online.


XDP_UK_REFERENCE
XDP Express Reference.


NINJAVAN_MY
ninja van (www.ninjavan.co).


ADICIONAL
Adicional Logistics.


ROADBULL
Red Carpet Logistics.


YAKIT
Yakit courier.


MAILAMERICAS
MailAmericas.


MIKROPAKKET
Mikropakket.


DYNALOGIC
Dynamic Logistics.


DHL_ES
DHL Spain(www.dhl.com).


DHL_PARCEL_NL
DHL Parcel NL.


DHL_GLOBAL_MAIL_ASIA
DHL Global Mail Asia (www.dhl.com).


DAWN_WING
Dawn Wing.


GENIKI_GR
Geniki Taxydromiki.


HERMESWORLD_UK
hermesworld_uk.


ALPHAFAST
Alphafast (www.alphafast.com).


BUYLOGIC
buylogic.


EKART
Ekart logistics (ekartlogistics.com).


MEX_SENDA
mexico senda express.


SFC_LOGISTICS
SFC.


POST_SERBIA
Posta Serbia.


IND_DELHIVERY
Delhivery India.


DE_DPD_DELISTRACK
DPD Germany.


RPD2MAN
RPD2man Deliveries.


CN_SF_EXPRESS
SF Express (www.sf-express.com).


YANWEN
Yanwen Logistics.


MYS_SKYNET
Skynet Malaysia.


CORREOS_DE_MEXICO
correos mexico.


CBL_LOGISTICA
CBL Logistica.


MEX_ESTAFETA
Estafeta (www.estafeta.com).


AU_AUSTRIAN_POST
Austrian Post (Registered).


RINCOS
Rincos.


NLD_DHL
DHL Netherland.


RUSSIAN_POST
Russian post.


COURIERS_PLEASE
CouriersPlease (couriersplease.com.au).


POSTNORD_LOGISTICS
PostNord Logistics.


FEDEX
Fedex.


DPE_EXPRESS
DPE Express.


DPD
DPD.


ADSONE
ADSone.


IDN_JNE
JNE Express (Jalur Nugraha Ekakurir).


THECOURIERGUY
The Courier Guy.


CNEXPS
CNE Express.


PRT_CHRONOPOST
Chronopost Portugal.


LANDMARK_GLOBAL
Landmark Global.


IT_DHL_ECOMMERCE
DHL International.


ESP_NACEX
NACEX Spain.


PRT_CTT
CTT Portugal.


BE_KIALA
Kiala.


ASENDIA_UK
Asendia UK.


GLOBAL_TNT
TNT global.


POSTUR_IS
Iceland Post.


EPARCEL_KR
eParcel Korea.


INPOST_PACZKOMATY
InPost Paczkomaty.


IT_POSTE_ITALIA
Poste italiane (www.poste.it).


BE_BPOST
Bpost (www.bpost.be).


PL_POCZTA_POLSKA
Poczta Polska (www.poczta-polska.pl).


MYS_MYS_POST
Malaysia Post.


SG_SG_POST
Singapore Post.


THA_THAILAND_POST
Thailand Post (www.thailandpost.co.th).


LEXSHIP
LexShip.


FASTWAY_NZ
Fastway New Zealand.


DHL_AU
DHL Supply Chain Australia.


COSTMETICSNOW
Cosmetics Now.


PFLOGISTICS
PFL.


LOOMIS_EXPRESS
Loomis Express.


GLS_ITALY
GLS Italy.


LINE
Line Clear Express & Logistics Sdn Bhd.


GEL_EXPRESS
Gel Express Logistik.


HUODULL
Huodull.


NINJAVAN_SG
Ninja van Singapore.


JANIO
Janio Asia.


AO_COURIER
AO Logistics.


BRT_IT_SENDER_REF
BRT Bartolini(Sender Reference).


SAILPOST
SAILPOST.


LALAMOVE
Lalamove.


NEWZEALAND_COURIERS
NEW ZEALAND COURIERS.


ETOMARS
Etomars.


VIRTRANSPORT
VIR Transport.


WIZMO
Wizmo.


PALLETWAYS
Palletways.


I_DIKA
i-dika.


CFL_LOGISTICS
CFL Logistics.


GEMWORLDWIDE
GEM Worldwide.


GLOBAL_EXPRESS
Tai Wan Global Business.


LOGISTYX_TRANSGROUP
Transgroup courier.


WESTBANK_COURIER
West Bank Courier.


ARCO_SPEDIZIONI
Arco Spedizioni SP.


YDH_EXPRESS
YDH express.


PARCELINKLOGISTICS
Parcelink Logistics.


CNDEXPRESS
CND Express.


NOX_NIGHT_TIME_EXPRESS
NOX NightTimeExpress.


AERONET
Aeronet couriers.


LTIANEXP
LTIAN EXP.


INTEGRA2_FTP
Integra2.


PARCELONE
PARCEL ONE.


NOX_NACHTEXPRESS
Innight Express Germany GmbH (nox NachtExpress).


CN_CHINA_POST_EMS
China Post.


CHUKOU1
Chukou1.


GLS_SLOV
GLS General Logistics Systems Slovakia s.r.o..


ORANGE_DS
OrangeDS (Orange Distribution Solutions Inc).


JOOM_LOGIS
Joom Logistics.


AUS_STARTRACK
StarTrack (startrack.com.au).


DHL
dhl Global.


GB_APC
APC postal logistics germany.


BONDSCOURIERS
Bonds Courier Service (bondscouriers.com.au).


JPN_JAPAN_POST
Japan Post.


USPS
United States Postal Service.


WINIT
WinIt.


ARG_OCA
OCA Argentina.


TW_TAIWAN_POST
Taiwan Post.


DMM_NETWORK
DMM Network.


TNT
TNT Express.


BH_POSTA
BH Posta (www.posta.ba).


SWE_POSTNORD
Postnord sweden.


CA_CANADA_POST
Canada Post.


WISELOADS
Wiseloads.


ASENDIA_HK
Asendia HonKong.


NLD_GLS
GLS Netherland.


MEX_REDPACK
Redpack.


JET_SHIP
Jet-Ship Worldwide.


DE_DHL_EXPRESS
DHL Express.


NINJAVAN_THAI
Ninja van Thai.


RABEN_GROUP
Raben Group.


ESP_ASM
ASM(GLS Spain).


HRV_HRVATSKA
Hrvatska posta.


GLOBAL_ESTES
Estes Express Lines.


LTU_LIETUVOS
Lietuvos pastas.


BEL_DHL
DHL Benelux.


AU_AU_POST
Australia Post.


SPEEDEXCOURIER
SPEEDEX couriers.


FR_COLIS
Colissimo.


ARAMEX
Aramex.


DPEX
DPEX (www.dpex.com).


MYS_AIRPAK
Airpak Express.


CUCKOOEXPRESS
Cuckoo Express.


DPD_POLAND
DPD Poland.


NLD_POSTNL
PostNL International.


NIM_EXPRESS
Nim Express.


QUANTIUM
Quantium.


SENDLE
Sendle.


ESP_REDUR
Redur Spain.


MATKAHUOLTO
Matkahuolto.


CPACKET
Cpacket couriers.


POSTI
Posti courier.


HUNTER_EXPRESS
Hunter Express.


CHOIR_EXP
Choir Express Indonesia.


LEGION_EXPRESS
Legion Express.


AUSTRIAN_POST_EXPRESS
austrian post.


GRUPO
Grupo ampm.


POSTA_RO
Post Roman (www.posta-romana.ro).


INTERPARCEL_UK
Interparcel UK.


GLOBAL_ABF
ABF Freight.


POSTEN_NORGE
Posten Norge (www.posten.no).


XPERT_DELIVERY
Xpert Delivery.


DHL_REFR
DHl (Reference number).


DHL_HK
DHL HonKong.


SKYNET_UAE
SKYNET UAE.


GOJEK
Gojek.


YODEL_INTNL
Yodel International.


JANCO
Janco Ecommerce.


YTO
YTO Express.


WISE_EXPRESS
Wise Express.


JTEXPRESS_VN
J&T Express Vietnam.


FEDEX_INTL_MLSERV
FedEx International MailService.


VAMOX
VAMOX.


AMS_GRP
AMS Group.


DHL_JP
DHL Japan.


HRPARCEL
HR Parcel.


GESWL
GESWL Express.


BLUESTAR
Blue Star.


CDEK_TR
CDEK TR.


DESCARTES
Innovel courier.


DELTEC_UK
Deltec Courier.


DTDC_EXPRESS
DTDC express.


TOURLINE
tourline.


BH_WORLDWIDE
B&H Worldwide.


OCS
OCS ANA Group.


YINGNUO_LOGISTICS
yingnuo logistics.


UPS
United Parcel Service.


TOLL
Toll IPEC.


PRT_SEUR
SEUR portugal.


DTDC_AU
DTDC Australia.


THA_DYNAMIC_LOGISTICS
Dynamic Logistics.


UBI_LOGISTICS
UBI Smart Parcel.


FEDEX_CROSSBORDER
FedEx Cross Border.


A1POST
A1Post.


TAZMANIAN_FREIGHT
Tazmanian Freight Systems.


CJ_INT_MY
CJ International malaysia.


SAIA_FREIGHT
Saia LTL Freight.


SG_QXPRESS
Qxpress.


NHANS_SOLUTIONS
Nhans Solutions.


DPD_FR
DPD France.


COORDINADORA
Coordinadora.


ANDREANI
Grupo logistico Andreani.


DOORA
Doora Logistics.


INTERPARCEL_NZ
Interparcel New Zealand.


PHL_JAMEXPRESS
Jam Express Philippines.


BEL_BELGIUM_POST
bel_belgium_post.


US_APC
us_apc.


IDN_POS
idn_pos.


FR_MONDIAL
fr_mondial.


DE_DHL
DE DHL.


HK_RPX
hk_rpx.


DHL_PIECEID
dhl_pieceid.


VNPOST_EMS
vnpost_ems.


RRDONNELLEY
rrdonnelley.


DPD_DE
dpd_de.


DELCART_IN
delcart_in.


IMEXGLOBALSOLUTIONS
imexglobalsolutions.


ACOMMERCE
ACOMMERCE.


EURODIS
eurodis.


CANPAR
CANPAR.


GLS
GLS.


IND_ECOM
Ecom Express.


ESP_ENVIALIA
Envialia.


DHL_UK
dhl UK.


SMSA_EXPRESS
SMSA Express.


TNT_FR
TNT France.


DEX_I
DEX-I courier.


BUDBEE_WEBHOOK
Budbee courier.


COPA_COURIER
Copa Airlines Courier.


VNM_VIETNAM_POST
Vietnam Post.


DPD_HK
DPD HongKong.


TOLL_NZ
Toll New Zealand.


ECHO
Echo courier.


FEDEX_FR
FedEx® Freight.


BORDEREXPRESS
Border Express.


MAILPLUS_JPN
MailPlus (Japan).


TNT_UK_REFR
TNT UK Reference.


KEC
KEC courier.


DPD_RO
DPD Romania.


TNT_JP
TNT_JP.


TH_CJ
TH_CJ.


EC_CN
EC_CN.


FASTWAY_UK
FASTWAY_UK.


FASTWAY_US
FASTWAY_US.


GLS_DE
GLS_DE.


GLS_ES
GLS_ES.


GLS_FR
GLS_FR.


MONDIAL_BE
MONDIAL_BE.


SGT_IT
SGT_IT.


TNT_CN
TNT_CN.


TNT_DE
TNT_DE.


TNT_ES
TNT_ES.


TNT_PL
TNT_PL.


PARCELFORCE
PARCELFORCE.


SWISS_POST
SWISS POST.


TOLL_IPEC
TOLL IPEC.


AIR_21
AIR 21.


AIRSPEED
AIRSPEED.


BERT
BERT.


BLUEDART
BLUEDART.


COLLECTPLUS
COLLECTPLUS.


COURIERPLUS
COURIERPLUS.


COURIER_POST
COURIER POST.


DHL_GLOBAL_MAIL
dhl_global_mail.


DPD_UK
dpd_uk.


DELTEC_DE
DELTEC DE.


DEUTSCHE_DE
deutsche_de.


DOTZOT
DOTZOT.


ELTA_GR
elta_gr.


EMS_CN
ems_cn.


ECARGO
ECARGO.


ENSENDA
ENSENDA.


FERCAM_IT
fercam_it.


FASTWAY_ZA
fastway_za.


FASTWAY_AU
fastway_au.


FIRST_LOGISITCS
first_logisitcs.


GEODIS
GEODIS.


GLOBEGISTICS
GLOBEGISTICS.


GREYHOUND
GREYHOUND.


JETSHIP_MY
jetship_my.


LION_PARCEL
LION PARCEL.


AEROFLASH
AEROFLASH.


ONTRAC
ONTRAC.


SAGAWA
SAGAWA.


SIODEMKA
SIODEMKA.


STARTRACK
startrack.


TNT_AU
tnt_au.


TNT_IT
tnt_it.


TRANSMISSION
TRANSMISSION.


YAMATO
YAMATO.


DHL_IT
dhl_it.


DHL_AT
dhl_at.


LOGISTICSWORLDWIDE_KR
LOGISTICSWORLDWIDE KR.


GLS_SPAIN
gls_spain.


AMAZON_UK_API
amazon_uk_api.


DPD_FR_REFERENCE
dpd_fr_reference.


DHLPARCEL_UK
dhlparcel_uk.


MEGASAVE
megasave.


QUALITYPOST
qualitypost.


IDS_LOGISTICS
ids_logistics.


JOYINGBOX
joyingbox.


PANTHER_ORDER_NUMBER
panther_order_number.


WATKINS_SHEPARD
watkins_shepard.


FASTTRACK
fasttrack.


UP_EXPRESS
up_express.


ELOGISTICA
elogistica.


ECOURIER
ecourier.


CJ_PHILIPPINES
cj_philippines.


SPEEDEX
speedex.


ORANGECONNEX
orangeconnex.


TECOR
tecor.


SAEE
saee.


GLS_ITALY_FTP
gls_italy_ftp.


DELIVERE
delivere.


YYCOM
yycom.


ADICIONAL_PT
Adicional Logistics.


DKSH
DKSH.


NIPPON_EXPRESS_FTP
Nippon Express.


GOLS
GO Logistics & Storage.


FUJEXP
FUJIE EXPRESS.


QTRACK
QTrack.


OMLOGISTICS_API
OM LOGISTICS LTD.


GDPHARM
GDPharm Logistics.


MISUMI_CN
MISUMI Group Inc..


AIR_CANADA
Rivo.


CITY56_WEBHOOK
City Express.


SAGAWA_API
Sagawa.


KEDAEX
KedaEX.


PGEON_API
Pgeon.


WEWORLDEXPRESS
We World Express.


JT_LOGISTICS
J&T International logistics.


TRUSK
Trusk France.


VIAXPRESS
ViaXpress.


DHL_SUPPLYCHAIN_ID
DHL Supply Chain Indonesia.


ZUELLIGPHARMA_SFTP
Zuellig Pharma Korea.


MEEST
Meest.


TOLL_PRIORITY
Toll Priority.


MOTHERSHIP_API
Mothership.


CAPITAL
Capital Transport.


EUROPAKET_API
Europacket+.


HFD
HFD.


TOURLINE_REFERENCE
Tourline Express.


GIO_ECOURIER
GIO Express Inc.


CN_LOGISTICS
CN Logistics.


PANDION
Pandion.


BPOST_API
Bpost API.


PASSPORTSHIPPING
Passport Shipping.


PAKAJO
Pakajo World.


DACHSER
DACHSER.


YUSEN_SFTP
Yusen Logistics.


SHYPLITE
Shypmax.


XYY
Xingyunyi Logistics.


MWD
Metropolitan Warehouse & Delivery.


FAXECARGO
Faxe Cargo.


MAZET
Groupe Mazet.


FIRST_LOGISTICS_API
First Logistics.


SPRINT_PACK
SPRINT PACK.


HERMES_DE_FTP
Hermes Germany.


CONCISE
Concise.


KERRY_EXPRESS_TW_API
Kerry Express TaiWan.


EWE
EWE Global Express.


FASTDESPATCH
Fast Despatch Logistics Limited.


ABCUSTOM_SFTP
AB Custom Group.


CHAZKI
Chazki.


SHIPPIE
Shippie.


GEODIS_API
GEODIS - Distribution & Express.


NAQEL_EXPRESS
Naqel Express.


PAPA_WEBHOOK
Papa.


FORWARDAIR
Forward Air.


DIALOGO_LOGISTICA_API
Dialogo Logistica.


LALAMOVE_API
Lalamove.


TOMYDOOR
Tomydoor.


KRONOS_WEBHOOK
Kronos Express.


JTCARGO
J&T CARGO.


T_CAT
T-cat.


CONCISE_WEBHOOK
Concise.


TELEPORT_WEBHOOK
Teleport.


CUSTOMCO_API
The Custom Companies.


SPX_TH
Shopee Xpress.


BOLLORE_LOGISTICS
Bollore Logistics.


CLICKLINK_SFTP
ClickLink.


M3LOGISTICS
M3 Logistics.


VNPOST_API
Vietnam Post.


AXLEHIRE_FTP
Axlehire.


SHADOWFAX
Shadowfax.


MYHERMES_UK_API
EVRi.


DAIICHI
Daiichi Freight System Inc.


MENSAJEROSURBANOS_API
Mensajeros Urbanos.


POLARSPEED
PolarSpeed Inc.


IDEXPRESS_ID
iDexpress Indonesia.


PAYO
Payo.


WHISTL_SFTP
Whistl.


INTEX_DE
INTEX Paketdienst GmbH.


TRANS2U
Trans2u.


PRODUCTCAREGROUP_SFTP
Product Care Services Limited.


BIGSMART
Big Smart.


EXPEDITORS_API_REF
Expeditors API Reference.


AITWORLDWIDE_API
AIT.


WORLDCOURIER
World Courier.


QUIQUP
Quiqup.


AGEDISS_SFTP
Agediss.


ANDREANI_API
Andreani.


CRLEXPRESS
CRL Express.


SMARTCAT
SMARTCAT.


CROSSFLIGHT
Crossflight Limited.


PROCARRIER
Pro Carrier.


DHL_REFERENCE_API
DHL (Reference number).


SEINO_API
Seino.


WSPEXPRESS
WSP Express.


KRONOS
Kronos Express.


TOTAL_EXPRESS_API
Total Express.


PARCLL
PARCLL.


XPEDIGO
Xpedigo.


STAR_TRACK_WEBHOOK
StarTrack.


GPOST
Georgian Post.


UCS
UCS.


DMFGROUP
DMF.


COORDINADORA_API
Coordinadora.


MARKEN
Marken.


NTL
NTL logistics.


REDJEPAKKETJE
Red je Pakketje.


ALLIED_EXPRESS_FTP
Allied Express (FTP).


MONDIALRELAY_ES
Mondial Relay Spain(Punto Pack).


NAEKO_FTP
Naeko Logistics.


MHI
Mhi.


SHIPPIFY
Shippify, Inc.


MALCA_AMIT_API
Malca Amit.


JTEXPRESS_SG_API
J&T Express Singapore.


DACHSER_WEB
DACHSER.


FLIGHTLG
Flight Logistics Group.


CAGO
Cago.


COM1EXPRESS
ComOne Express.


TONAMI_FTP
Tonami.


PACKFLEET
PACKFLEET.


PUROLATOR_INTERNATIONAL
Purolator International.


WINESHIPPING_WEBHOOK
Wineshipping.


DHL_ES_SFTP
DHL Spain Domestic.


PCHOME_API
網家速配股份有限公司.


CESKAPOSTA_API
Czech Post.


GORUSH
Go Rush.


HOMERUNNER
HomeRunner.


AMAZON_ORDER
Amazon order.


EFWNOW_API
Estes Forwarding Worldwide.


CBL_LOGISTICA_API
CBL Logistica (API).


NIMBUSPOST
NimbusPost.


LOGWIN_LOGISTICS
Logwin Logistics.


NOWLOG_API
Sequoialog.


DPD_NL
DPD Netherlands.


GODEPENDABLE
Dependable Supply Chain Services.


ESDEX
Top Ideal Express.


LOGISYSTEMS_SFTP
Kiitäjät.


EXPEDITORS
Expeditors.


SNTGLOBAL_API
Snt Global Etrax.


SHIPX
ShipX.


QINTL_API
Quickstat Courier LLC.


PACKS
Packs.


POSTNL_INTERNATIONAL
PostNL International.


AMAZON_EMAIL_PUSH
Amazon.


DHL_API
DHL.


SPX
Shopee Express.


AXLEHIRE
AxleHire.


ICSCOURIER
ICS COURIER.


DIALOGO_LOGISTICA
Dialogo Logistica.


SHUNBANG_EXPRESS
ShunBang Express.


TCS_API
TCS.


SF_EXPRESS_CN
SF Express China.


PACKETA
Packeta.


SIC_TELIWAY
Teliway SIC Express.


MONDIALRELAY_FR
Mondial Relay France.


INTIME_FTP
InTime.


JD_EXPRESS
京东物流.


FASTBOX
Fastbox.


PATHEON
Patheon Logistics.


INDIA_POST
India Post Domestic.


TIPSA_REF
Tipsa Reference.


ECOFREIGHT
Eco Freight.


VOX
VOX SOLUCION EMPRESARIAL SRL.


DIRECTFREIGHT_AU_REF
Direct Freight Express.


BESTTRANSPORT_SFTP
Best Transport.


AUSTRALIA_POST_API
Australia Post.


FRAGILEPAK_SFTP
FragilePAK.


FLIPXP
FlipXpress.


VALUE_WEBHOOK
Value Logistics.


DAESHIN
Daeshin.


SHERPA
Sherpa.


MWD_API
Metropolitan Warehouse & Delivery.


SMARTKARGO
SmartKargo.


DNJ_EXPRESS
DNJ Express.


GOPEOPLE
Go People.


MYSENDLE_API
mySendle.


ARAMEX_API
Aramex.


PIDGE
Pidge.


THAIPARCELS
TP Logistic.


PANTHER_REFERENCE_API
Panther Reference.


POSTAPLUS
Posta Plus.


BUFFALO
BUFFALO.


U_ENVIOS
U-ENVIOS.


ELITE_CO
Elite Express.


ROCHE_INTERNAL_SFTP
Roche Internal Courier.


DBSCHENKER_ICELAND
DB Schenker Iceland.


TNT_FR_REFERENCE
TNT France Reference.


NEWGISTICSAPI
Newgistics API.


GLOVO
Glovo.


GWLOGIS_API
G.I.G.


SPREETAIL_API
Spreetail.


MOOVA
Moova.


PLYCONGROUP
Plycon Transportation Group.


USPS_WEBHOOK
USPS Informed Visibility - Webhook.


REIMAGINEDELIVERY
maergo.


EDF_FTP
Eurodifarm.


DAO365
DAO365.


BIOCAIR_FTP
BioCair.


RANSA_WEBHOOK
Ransa.


SHIPXPRES
SHIPXPRESS.


COURANT_PLUS_API
Courant Plus.


SHIPA
SHIPA.


HOMELOGISTICS
Home Logistics.


DX
DX.


POSTE_ITALIANE_PACCOCELERE
Poste Italiane Paccocelere.


TOLL_WEBHOOK
Toll Group.


LCTBR_API
LCT do Brasil.


DX_FREIGHT
DX Freight.


DHL_SFTP
DHL Express.


SHIPROCKET
Shiprocket X.


UBER_WEBHOOK
Uber.


STATOVERNIGHT
Stat Overnight.


BURD
Burd Delivery.


FASTSHIP
Fastship Express.


IBVENTURE_WEBHOOK
IB Venture.


GATI_KWE_API
Gati-KWE.


CRYOPDP_FTP
CryoPDP.


HUBBED
HUBBED.


TIPSA_API
Tipsa API.


ARASKARGO
Aras Cargo.


THIJS_NL
Thijs Logistiek.


ATSHEALTHCARE_REFERENCE
ATS Healthcare.


99MINUTOS
99minutos.


HELLENIC_POST
Hellenic (Greece) Post.


HSM_GLOBAL
HSM Global.


MNX
MNX.


NMTRANSFER
N&M Transfer Co., Inc..


LOGYSTO
Logysto.


INDIA_POST_INT
India Post International.


AMAZON_FBA_SWISHIP_IN
Swiship IN.


SRT_TRANSPORT
SRT Transport.


BOMI
Bomi Group.


DELIVERR_SFTP
Deliverr.


HSDEXPRESS
HSDEXPRESS.


SIMPLETIRE_WEBHOOK
SimpleTire.


HUNTER_EXPRESS_SFTP
Hunter Express.


UPS_API
UPS.


WOOYOUNG_LOGISTICS_SFTP
WOO YOUNG LOGISTICS CO.,LTD..


PHSE_API
PHSE.


WISH_EMAIL_PUSH
Wish.


NORTHLINE
Northline.


MEDAFRICA
Med Africa Logistics.


DPD_AT_SFTP
DPD Austria.


ANTERAJA
Anteraja.


DHL_GLOBAL_FORWARDING_API
DHL Global Forwarding API.


LBCEXPRESS_API
LBC EXPRESS INC..


SIMSGLOBAL
Sims Global.


CDLDELIVERS
CDL Last Mile.


TYP
TYP.


TESTING_COURIER_WEBHOOK
Testing Courier.


PANDAGO_API
Pandago.


ROYAL_MAIL_FTP
Royal Mail.


THUNDEREXPRESS
Thunder Express Australia.


SECRETLAB_WEBHOOK
Secretlab.


SETEL
Setel Express.


JD_WORLDWIDE
JD Worldwide.


DPD_RU_API
DPD Russia.


ARGENTS_WEBHOOK
Argents Express Group.


POSTONE
Post ONE.


TUSKLOGISTICS
Tusk Logistics.


RHENUS_UK_API
Rhenus Logistics UK.


TAQBIN_SG_API
Yamato Singapore.


INNTRALOG_SFTP
Inntralog GmbH.


DAYROSS
Day & Ross.


CORREOSEXPRESS_API
Correos Express (API).


INTERNATIONAL_SEUR_API
International Seur API.


YODEL_API
Yodel API.


HEROEXPRESS
Hero Express.


DHL_SUPPLYCHAIN_IN
DHL supply chain India.


URGENT_CARGUS
Urgent Cargus.


FRONTDOORCORP
FRONTdoor Collective.


JTEXPRESS_PH
J&T Express Philippines.


PARCELSTARS_WEBHOOK
Parcelstars.


DPD_SK_SFTP
DPD Slovakia.


MOVIANTO
Movianto.


OZEPARTS_SHIPPING
Ozeparts Shipping.


KARGOMKOLAY
KargomKolay (CargoMini).


TRUNKRS
Trunkrs.


OMNIRPS_WEBHOOK
Omni Returns.


CHILEXPRESS
Chile Express.


TESTING_COURIER
Testing Courier.


JNE_API
JNE (API).


BJSHOMEDELIVERY_FTP
BJS Distribution, Storage & Couriers - FTP.


DEXPRESS_WEBHOOK
D Express.


USPS_API
USPS API.


TRANSVIRTUAL
TransVirtual.


SOLISTICA_API
solistica.


CHIENVENTURE_WEBHOOK
Chienventure.


DPD_UK_SFTP
DPD UK.


INPOST_UK
InPost.


JAVIT
Javit.


ZTO_DOMESTIC
ZTO Express China.


DHL_GT_API
DHL Global Forwarding Guatemala.


CEVA_TRACKING
CEVA Package.


KOMON_EXPRESS
Komon Express.


EASTWESTCOURIER_FTP
East West Courier Pte Ltd.


DANNIAO
Danniao.


SPECTRAN
Spectran.


DELIVER_IT
Deliver-iT.


RELAISCOLIS
Relais Colis.


GLS_SPAIN_API
GLS Spain.


POSTPLUS
PostPlus.


AIRTERRA
Airterra.


GIO_ECOURIER_API
GIO Express Ecourier.


DPD_CH_SFTP
DPD Switzerland.


FEDEX_API
FedEx®.


INTERSMARTTRANS
INTERSMARTTRANS & SOLUTIONS SL.


HERMES_UK_SFTP
Hermes UK.


EXELOT_FTP
Exelot Ltd..


DHL_PA_API
DHL GLOBAL FORWARDING PANAMÁ.


VIRTRANSPORT_SFTP
Vir Transport.


WORLDNET
Worldnet Logistics.


INSTABOX_WEBHOOK
Instabox.


KNG
Keuhne + Nagel Global.


FLASHEXPRESS_WEBHOOK
Flash Express.


MAGYAR_POSTA_API
Magyar Posta.


WESHIP_API
WeShip.


OHI_WEBHOOK
Ohi.


MUDITA
MUDITA.


BLUEDART_API
Bluedart.


T_CAT_API
T-cat.


ADS
ADS Express.


HERMES_IT
HR Parcel.


FITZMARK_API
FitzMark.


POSTI_API
Posti API.


SMSA_EXPRESS_WEBHOOK
SMSA Express.


TAMERGROUP_WEBHOOK
Tamer Logistics.


LIVRAPIDE
Livrapide.


NIPPON_EXPRESS
Nippon Express.


BETTERTRUCKS
Better Trucks.


FAN
FAN COURIER EXPRESS.


PB_USPSFLATS_FTP
USPS Flats (Pitney Bowes).


PARCELRIGHT
Parcel Right.


ITHINKLOGISTICS
iThink Logistics.


KERRY_EXPRESS_TH_WEBHOOK
Kerry Logistics.


ECOUTIER
eCoutier.


SHOWL
SENHONG INTERNATIONAL LOGISTICS.


BRT_IT_API
BRT Bartolini API.


RIXONHK_API
Rixon Logistics.


DBSCHENKER_API
DB Schenker.


ILYANGLOGIS
Ilyang logistics.


MAIL_BOX_ETC
Mail Boxes Etc..


WESHIP
WeShip.


DHL_GLOBAL_MAIL_API
DHL eCommerce Solutions.


ACTIVOS24_API
Activos24.


ATSHEALTHCARE
ATS Healthcare.


LUWJISTIK
Luwjistik.


GW_WORLD
Gebrüder Weiss.


FAIRSENDEN_API
fairsenden.


SERVIP_WEBHOOK
SerVIP.


SWISHIP
Swiship.


TANET
Transport Ambientales.


HOTSIN_CARGO
SHENZHEN HOTSIN CARGO INT'L FORWARDING CO.,LTD.


DIREX
Direx.


HUANTONG
HuanTong.


IMILE_API
iMile.


AUEXPRESS
Au Express.


NYTLOGISTICS
NYT SUPPLY CHAIN LOGISTICS Co.,LTD.


DSV_REFERENCE
DSV Futurewave.


NOVOFARMA_WEBHOOK
Novofarma.


AITWORLDWIDE_SFTP
AIT.


SHOPOLIVE
Olive.


FNF_ZA
Fast & Furious.


DHL_ECOMMERCE_GC
DHL eCommerce Greater China.


FETCHR
Fetchr.


STARLINKS_API
Starlinks Global.


YYEXPRESS
YYEXPRESS.


SERVIENTREGA
Servientrega.


HANJIN
HanJin.


SPANISH_SEUR_FTP
Spanish Seur.


DX_B2B_CONNUM
DX (B2B).


HELTHJEM_API
Helthjem.


INEXPOST
Inexpost.


A2B_BA
A2B Express Logistics.


RHENUS_GROUP
Rhenus Logistics.


SBERLOGISTICS_RU
Sber Logistics.


MALCA_AMIT
Malca-Amit.


PPL
Professional Parcel Logistics.


OSM_WORLDWIDE_SFTP
OSM Worldwide.


ACILOGISTIX
ACI Logistix.


OPTIMACOURIER
Optima Courier.


NOVA_POSHTA_API
Nova Poshta API.


LOGGI
Loggi.


YIFAN
YiFan Express.


MYDYNALOGIC
My DynaLogic.


MORNINGLOBAL
Morning Global.


CONCISE_API
Concise.


FXTRAN
Falcon Express.


DELIVERYOURPARCEL_ZA
Deliver Your Parcel.


UPARCEL
uParcel.


MOBI_BR
Mobi Logistica.


LOGINEXT_WEBHOOK
T&W Delivery.


EMS
EMS.


SPEEDY
Speedy.


ZOOM_RED
Zoom.


NAVLUNGO
Navlungo.


CASTLEPARCELS
Castle Parcels.


WEEE
Weee.


PACKALY
Packaly.


YUNHUIPOST
Yunhuipost.


YOUPARCEL
YouParcel.


LEMAN
Leman.


MOOVIN
Moovin.


URB_IT
Urb-it.


MULTIENTREGAPANAMA
Multientrega.


JUSDASR
Jusdasr.


DISCOUNTPOST
Discount Post.


RHENUS_UK
Rhenus Logistics UK.


SWISHIP_JP
Swiship JP.


GLS_US
GLS USA.


SMTL
Southwestern Motor Transport. Inc.


EMEGA
Discount Post Emega.


EXPRESSONE_SV
EXPRESSONE Slovenia.


HEPSIJET
hepsiJET.


WELIVERY
Welivery.


BRINGER
Bringer Parcel Services.


EASYROUTES
EasyRoutes.


MRW
MRW.


RPM
RPM.


DPD_PRT
DPD Portugal.


GLS_ROMANIA
GLS Romania.


LMPARCEL
LM Parcel.


GTAGSM
GTA GSM.


DOMINO
DOMINO.


ESHIPPER
eShipper.


TRANSPAK
Transpak Inc..


XINDUS
Xindus.


AOYUE
Aoyue.


EASYPARCEL
Easyparcel.


EXPRESSONE
EXPRESSONE.


SENDEO_KARGO
Sendeo Kargo.


SPEEDAF
Speedaf Express.


ETOWER
eTower.


GCX
GC Express.


NINJAVAN_VN
Ninjavan Vietnam.


ALLEGRO
Allegro.


JUMPPOINT
Jumppoint.


SHIPGLOBAL_US
ShipGlobal.


KINISI
Kinisi Transport Pty Ltd.


OAKH
Oakh Harbour Freight Lines.


AWEST
American West.


BARSAN
Barsan Global Lojistik.


ENERGOLOGISTIC
Energo Logistic.


MADROOEX
Madrooex.


GOBOLT
GoBolt.


SWISS_UNIVERSAL_EXPRESS
Swiss Universal Express.


IORDIRECT
IOR Direct Solutions.


XMSZM
xmszm.


GLS_HUN
GLS Hungary.


SENDY
Sendy Express.


BRAUNSEXPRESS
Brauns Express.


GRANDSLAMEXPRESS
Grand Slam Express.


XGS
XGS.


OTSCHILE
OTS.


PACK_UP
Pack-Up.


PARCELSTARS
Parcelstars.


TEAMEXPRESSLLC
Team Express Service LLC.


ASYADEXPRESS
Asyad Express.


TDN
TDN.


EARLYBIRD
Early Bird.


CACESA
Cacesa.


PARCELJET
Parceljet.


MNG_KARGO
MNG Kargo.


SUPERPACKLINE
Super Pac Line.


SPEEDX
SpeedX.


VESYL
Vesyl.


SKYKING
Sky King.


DIRMENSAJERIA
DIR.


NETLOGIXGROUP
Netlogix.


ZYOU
ZYEX.


JAWAR
Jawar.


AGSYSTEMS
Associate Global Systems.


GPS
GPS.


PTT_KARGO
PTT Kargo.


MAERGO
Maergo.


ARIHANTCOURIER
AICS.


VTFE
VicTas Freight Express.


YUNANT
Yunant.


URBIFY
Urbify.


PACK_MAN
pack-man.


LIEFERGRUN
LIEFERGRUN.


OBIBOX
Obibox.


PAIKEDA
Paikeda.


SCOTTY
Scotty.


INTELCOM_CA
Intelcom.


SWE
swe.


ASENDIA
Asendia Global.


DPD_AT
DPD Austria.


RELAY
Relay.


ATA
ATA.


SKYEXPRESS_INTERNATIONAL
SkyExpress Internationals.


SURAT_KARGO
Surat Kargo.


SGLINK
SG LINK.


FLEETOPTICSINC
FleetOptics.


SHOPLINE
shopline.


PIGGYSHIP
PIGGYSHIP.


LOGOIX
LogoiX.


KOLAY_GELSIN
Kolay Gelsin.


ASSOCIATED_COURIERS
Associated Couriers.


UPS_CHECKER
ups-checker.


WINESHIPPING
Wineshipping.


SPEDISCI
Spedisci online.


 
capture_id
required
string  [ 1 .. 50 ] characters ^[a-zA-Z0-9]*$
The PayPal capture ID.


 
notify_payer
boolean
 Default:  false
If true, PayPal will send an email notification to the payer of the PayPal transaction. The email contains the tracking details provided through the Orders tracking API request. Independent of any value passed for notify_payer, the payer may receive tracking notifications within the PayPal app, based on the user's notification preferences.


 
Array of objects (tracker_item) 
An array of details of items in the shipment.


 
Responses 
200
A successful response to an idempotent request returns the HTTP 200 OK status code with a JSON response body that shows tracker details.


201
A successful response to a non-idempotent request returns the HTTP 201 Created status code with a JSON response body that shows tracker details. If a duplicate response is retried, returns the HTTP 200 OK status code.


400
Request is not well-formed, syntactically incorrect, or violates schema.


403
Authorization failed due to insufficient permissions.


422
The requested action could not be performed, semantically incorrect, or failed business validation.


500
An internal server error has occurred.


Request samples 
Response samples 
application/json
{}
Update or cancel tracking information for an order
patch/v2/checkout/orders/{id}/trackers/{tracker_id}
Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:

AttributeOpNotes
itemsreplaceUsing replace op for items will replace the entire items object with the value sent in request.
notify_payerreplace, add
statusreplaceOnly patching status to CANCELLED is currently supported.


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order that the tracking information is associated with.


 
tracker_id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The order tracking ID.


 
header Parameters
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.


 
Request Body schema: application/json
 Array ([ 0 .. 32767 ] items)
op
required
string
The operation.


 Enum Value Description
add
Depending on the target location reference, completes one of these functions:
  • The target location is an array index. Inserts a new value into the array at the specified index.
  • The target location is an object parameter that does not already exist. Adds a new parameter to the object.
  • The target location is an object parameter that does exist. Replaces that parameter's value.
The value parameter defines the value to add. For more information, see 4.1. add.


remove
Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.


replace
Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.


move
Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move.


copy
Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy.


test
Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:
TypeConsidered equal if both values
stringsContain the same number of Unicode characters and their code points are byte-by-byte equal.
numbersAre numerically equal.
arraysContain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
objectsContain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
literals (false, true, and null)Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.
For more information, see 4.6. test.


 
path
string
The JSON Pointer to the target document location at which to complete the operation.


 
value
any (Patch Value) 
The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified.


 
from
string
The JSON Pointer to the target document location from which to move the value. Required for the move operation.


 
Responses 
204
A successful request returns the HTTP 204 No Content status code with an empty object in the JSON response body.


400
Request is not well-formed, syntactically incorrect, or violates schema.


403
Authorization failed due to insufficient permissions.


404
The specified resource does not exist.


422
The requested action could not be performed, semantically incorrect, or failed business validation.


500
An internal server error has occurred.


Request samples 
Response samples 
application/json
{ }
Receive updated order information via callback URL
post/v2/checkout/orders/order-update-callback
The documentation for this 'endpoint' is different from the other endpoints under v2 Orders. For this endpoint the role of client and server is reversed. The client sending the request is PayPal, and the server sending the response is the merchant. In the request, PayPal will send the buyer's redacted shipping address and selected shipping option to the callback URL defined the create order request. The response from the merchant will update the Orders resource.


Request 
Request Body schema: 
required
Array of objects (Purchase Unit Request)   = 1 items 
An array of purchase units. At present only 1 purchase_unit is supported. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.


 
required
object (Portable Postal Address (Medium-Grained)) 
Redacted shipping address to be used for shipping options and tax calculations.


 
object (shipping_option) 
Buyer selected shipping option.


 
Responses 
200
The callback to merchant was successful.


Request samples 
Response samples 
application/json
{
  • "id": "8HFTASDATTV",
  • "purchase_units": [
    • {
      • "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
      • "amount": {
        • "currency_code": "USD",
        • "value": "105.00",
        • "breakdown": {
          • "item_total": {
            • "currency_code": "USD",
            • "value": "100.00"
            },
          • "tax_total": {
            • "currency_code": "USD",
            • "value": "5.00"
            },
          • "shipping": {
            • "currency_code": "USD",
            • "value": "0.00"
            }
          }
        },
      • "shipping_options": [
        • {
          • "id": "1",
          • "amount": {
            • "currencyCode": "USD",
            • "value": "0.00"
            },
          • "type": "SHIPPING",
          • "label": "Free Shipping",
          • "selected": true
          },
        • {
          • "id": "2",
          • "amount": {
            • "currencyCode": "USD",
            • "value": "7.00"
            },
          • "type": "SHIPPING",
          • "label": "USPS Priority Shipping",
          • "selected": false
          },
        • {
          • "id": "3",
          • "amount": {
            • "currencyCode": "USD",
            • "value": "10.00"
            },
          • "type": "SHIPPING",
          • "label": "1-Day Shipping",
          • "selected": false
          }
        ]
      }
    ]
}
Definitions
account_id
The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.


string <ppaas_payer_id_v3>  (account_id)   = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.


 
"stringstrings"
activity_timestamps
The date and time stamps that are common to authorized payment, captured payment, and refund transactions.


create_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction occurred, in Internet date and time format.


 
update_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction was last updated, in Internet date and time format.


 
{
  • "create_time": "string",
  • "update_time": "string"
}
altpay_customer
Alternative Payment Method (APM) customer information.


merchant_customer_id
string  [ 1 .. 64 ] characters ^[0-9a-zA-Z-_.^*$@#]+$
Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to get the ID of the merchant's customer.


 
{
  • "merchant_customer_id": "string"
}
amount_breakdown
The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.


object (Money) 
The subtotal for all items. Required if the request includes purchase_units[].items[].unit_amount. Must equal the sum of (items[].unit_amount * items[].quantity) for all items. item_total.value can not be a negative number.


 
object (Money) 
The shipping fee for all items within a given purchase_unit. shipping.value can not be a negative number.


 
object (Money) 
The handling fee for all items within a given purchase_unit. handling.value can not be a negative number.


 
object (Money) 
The total tax for all items. Required if the request includes purchase_units.items.tax. Must equal the sum of (items[].tax * items[].quantity) for all items. tax_total.value can not be a negative number.


 
object (Money) 
The insurance fee for all items within a given purchase_unit. insurance.value can not be a negative number.


 
object (Money) 
The shipping discount for all items within a given purchase_unit. shipping_discount.value can not be a negative number.


 
object (Money) 
The discount for all items within a given purchase_unit. discount.value can not be a negative number.


 
{
  • "item_total": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "shipping": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "handling": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "tax_total": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "insurance": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "shipping_discount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "discount": {
    • "currency_code": "str",
    • "value": "string"
    }
}
amount_with_breakdown
The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
If you specify amount.breakdown, the amount equals item_total plus tax_total plus shipping plus handling plus insurance minus shipping_discount minus discount.
The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.


currency_code
required
string <ppaas_common_currency_code_v2>  (currency_code)   = 3 characters 
The three-character ISO-4217 currency code that identifies the currency.


 
value
required
string  <= 32 characters ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be:
  • An integer for currencies like JPY that are not typically fractional.
  • A decimal fraction for currencies like TND that are subdivided into thousandths.
For the required number of decimal places for a currency code, see Currency Codes.


 
object (amount_breakdown) 
The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.


 
{
  • "currency_code": "str",
  • "value": "string",
  • "breakdown": {
    • "item_total": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "shipping": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "handling": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "tax_total": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "insurance": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "shipping_discount": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "discount": {
      • "currency_code": "str",
      • "value": "string"
      }
    }
}
apple_pay
Information needed to pay using ApplePay.


id
string  [ 1 .. 250 ] characters ^.*$
ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.


 
token
string  [ 1 .. 10000 ] characters ^.*$
Encrypted ApplePay token, containing card information. This token would be base64encoded. The pattern is defined by an external party and supports Unicode.


 
object (card_stored_credential) 
Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
  • payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
  • usage=FIRST is compatible only with payment_initiator=CUSTOMER.
  • previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
  • Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.


 
name
string (name)   [ 3 .. 300 ] characters 
Name on the wallet.


 
email_address
string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The email address of the account holder associated with this payment method.


 
object (Phone) 
The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.


 
object (apple_pay_card_response) 
The payment card information.


 
object (apple_pay_attributes_response) 
Additional attributes associated with apple pay.


 
{
  • "id": "string",
  • "token": "string",
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "acquirer_reference_number": "string",
      • "network": "VISA"
      }
    },
  • "name": "string",
  • "email_address": "string",
  • "phone_number": {
    • "national_number": "string"
    },
  • "card": {
    • "name": "string",
    • "last_digits": "string",
    • "available_networks": [
      • "VISA"
      ],
    • "from_request": {
      • "last_digits": "stri",
      • "expiry": "string"
      },
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        }
      },
    • "brand": "VISA",
    • "type": "CREDIT",
    • "authentication_result": {
      • "liability_shift": "NO",
      • "three_d_secure": {
        • "authentication_status": "Y",
        • "enrollment_status": "Y"
        }
      },
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "links": [
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "GET"
            }
          ],
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            },
          • "merchant_customer_id": "string"
          }
        }
      },
    • "expiry": "string",
    • "bin_details": {
      • "bin": "string",
      • "issuing_bank": "string",
      • "products": [
        • "string"
        ],
      • "bin_country_code": "string"
      },
    • "billing_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      },
    • "country_code": "string"
    },
  • "attributes": {
    • "vault": {
      • "id": "string",
      • "status": "VAULTED",
      • "links": [
        • {
          • "href": "string",
          • "rel": "string",
          • "method": "GET"
          }
        ],
      • "customer": {
        • "id": "string",
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          }
        }
      }
    }
}
apple_pay_attributes
Additional attributes associated with apple pay.


object (customer) 
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.


 
object (v3_vault_instruction_base) 
Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting.


 
{
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      }
    },
  • "vault": {
    • "store_in_vault": "ON_SUCCESS"
    }
}
apple_pay_attributes_response
Additional attributes associated with the use of Apple Pay.


object (vault_response) 
The details about a saved payment source.


 
{
  • "vault": {
    • "id": "string",
    • "status": "VAULTED",
    • "links": [
      • {
        • "href": "string",
        • "rel": "string",
        • "method": "GET"
        }
      ],
    • "customer": {
      • "id": "string",
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        }
      }
    }
}
apple_pay_card_response
The Card from Apple Pay Wallet used to fund the payment.


name
string  [ 2 .. 300 ] characters 
The card holder's name as it appears on the card.


 
last_digits
string[0-9]{2,}
The last digits of the payment card.


 
available_networks
Array of strings (card_brand)   [ 1 .. 256 ] items 
Array of brands or networks associated with the card.


Items Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
object (card_from_request) 
Representation of card details as received in the request.


 
object (card_stored_credential) 
Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
  • payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
  • usage=FIRST is compatible only with payment_initiator=CUSTOMER.
  • previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
  • Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.


 
brand
string (card_brand)   [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.


 Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
type
string (card_type)   [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.


 Enum Value Description
CREDIT
A credit card.


DEBIT
A debit card.


PREPAID
A Prepaid card.


STORE
A store card.


UNKNOWN
Card type cannot be determined.


 
object (authentication_response) 
Results of Authentication such as 3D Secure.


 
object (card_attributes_response) 
Additional attributes associated with the use of this card.


 
expiry
string (date_year_month)   = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format.


 
object (bin_details) 
Bank Identification Number (BIN) details used to fund a payment.


 
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
country_code
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "name": "string",
  • "last_digits": "string",
  • "available_networks": [
    • "VISA"
    ],
  • "from_request": {
    • "last_digits": "stri",
    • "expiry": "string"
    },
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "acquirer_reference_number": "string",
      • "network": "VISA"
      }
    },
  • "brand": "VISA",
  • "type": "CREDIT",
  • "authentication_result": {
    • "liability_shift": "NO",
    • "three_d_secure": {
      • "authentication_status": "Y",
      • "enrollment_status": "Y"
      }
    },
  • "attributes": {
    • "vault": {
      • "id": "string",
      • "status": "VAULTED",
      • "links": [
        • {
          • "href": "string",
          • "rel": "string",
          • "method": "GET"
          }
        ],
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          },
        • "merchant_customer_id": "string"
        }
      }
    },
  • "expiry": "string",
  • "bin_details": {
    • "bin": "string",
    • "issuing_bank": "string",
    • "products": [
      • "string"
      ],
    • "bin_country_code": "string"
    },
  • "billing_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    },
  • "country_code": "string"
}
apple_pay_decrypted_token_data
Information about the Payment data obtained by decrypting Apple Pay token.


device_manufacturer_id
string  [ 1 .. 2000 ] characters ^.*$
Apple Pay Hex-encoded device manufacturer identifier. The pattern is defined by an external party and supports Unicode.


 
payment_data_type
string  [ 1 .. 16 ] characters ^[0-9A-Z_]+$
Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for China it is EMV.


 Enum Value Description
3DSECURE
The card was authenticated using 3D Secure (3DS) authentication scheme. While using this value make sure to populate cryptogram and eci_indicator as part of payment data..


EMV
The card was authenticated using EMV method, which is applicable for China. While using this value make sure to pass emv_data and pin as part of payment data.


 
object (Money) 
The transaction amount for the payment that the payer has approved on apple platform.


 
required
object (card) 
Apple Pay tokenized credit card used to pay.


 
object (apple_pay_payment_data) 
Apple Pay payment data object which contains the cryptogram, eci_indicator and other data.


 
{
  • "device_manufacturer_id": "string",
  • "payment_data_type": "3DSECURE",
  • "transaction_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "tokenized_card": {
    • "name": "string",
    • "number": "stringstrings",
    • "expiry": "string",
    • "card_type": "VISA",
    • "type": "CREDIT",
    • "brand": "VISA",
    • "billing_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      }
    },
  • "payment_data": {
    • "cryptogram": "string",
    • "eci_indicator": "string",
    • "emv_data": "string",
    • "pin": "string"
    }
}
apple_pay_experience_context
Customizes the payer experience during the approval process for the payment.


return_url
required
string <uri>  (url) 
The URL where the customer is redirected after the customer approves the payment.


 
cancel_url
required
string <uri>  (url) 
The URL where the customer is redirected after the customer cancels the payment.


 
{
  • "return_url": "string",
  • "cancel_url": "string"
}
apple_pay_payment_data
Information about the decrypted apple pay payment data for the token like cryptogram, eci indicator.


cryptogram
string  [ 1 .. 2000 ] characters ^.*$
Online payment cryptogram, as defined by 3D Secure. The pattern is defined by an external party and supports Unicode.


 
eci_indicator
string  [ 1 .. 256 ] characters ^.*$
ECI indicator, as defined by 3- Secure. The pattern is defined by an external party and supports Unicode.


 
emv_data
string  [ 1 .. 2000 ] characters ^.*$
Encoded Apple Pay EMV Payment Structure used for payments in China. The pattern is defined by an external party and supports Unicode.


 
pin
string  [ 1 .. 2000 ] characters ^.*$
Bank Key encrypted Apple Pay PIN. The pattern is defined by an external party and supports Unicode.


 
{
  • "cryptogram": "string",
  • "eci_indicator": "string",
  • "emv_data": "string",
  • "pin": "string"
}
apple_pay_request
Information needed to pay using ApplePay.


id
string  [ 1 .. 250 ] characters ^.*$
ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.


 
object (card_stored_credential) 
Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
  • payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
  • usage=FIRST is compatible only with payment_initiator=CUSTOMER.
  • previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
  • Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.


 
object (apple_pay_attributes) 
Additional attributes associated with apple pay.


 
name
string (name)   [ 3 .. 300 ] characters 
Name on the account holder associated with apple pay.


 
email_address
string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The email address of the account holder associated with apple pay.


 
object (Phone) 
The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.


 
object (apple_pay_decrypted_token_data) 
The decrypted payload details for the apple pay token.


 
vault_id
string (vault_id)   [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the saved apple pay payment_source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.


 
object (apple_pay_experience_context) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "id": "string",
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "acquirer_reference_number": "string",
      • "network": "VISA"
      }
    },
  • "attributes": {
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        }
      },
    • "vault": {
      • "store_in_vault": "ON_SUCCESS"
      }
    },
  • "name": "string",
  • "email_address": "string",
  • "phone_number": {
    • "national_number": "string"
    },
  • "decrypted_token": {
    • "device_manufacturer_id": "string",
    • "payment_data_type": "3DSECURE",
    • "transaction_amount": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "tokenized_card": {
      • "name": "string",
      • "number": "stringstrings",
      • "expiry": "string",
      • "card_type": "VISA",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        }
      },
    • "payment_data": {
      • "cryptogram": "string",
      • "eci_indicator": "string",
      • "emv_data": "string",
      • "pin": "string"
      }
    },
  • "vault_id": "string",
  • "experience_context": {
    • "return_url": "string",
    • "cancel_url": "string"
    }
}
application_context
Customizes the payer experience during the approval process for the payment with PayPal.
Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values.


brand_name
string  [ 1 .. 127 ] characters 
DEPRECATED. The label that overrides the business name in the PayPal account on the PayPal site. The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.brand_name). Please specify this field in the experience_context object instead of the application_context object.


 
landing_page
string (Order Application Context Landing Page)   [ 1 .. 13 ] characters ^[0-9A-Z_]+$
 Default:  "NO_PREFERENCE"
DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal site for customer checkout.  The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.landing_page). Please specify this field in the experience_context object instead of the application_context object.


 Enum Value Description
LOGIN
When the customer clicks PayPal Checkout, the customer is redirected to a page to log in to PayPal and approve the payment.


BILLING
When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or debit card and other relevant billing information required to complete the purchase.


NO_PREFERENCE
When the customer clicks PayPal Checkout, the customer is redirected to either a page to log in to PayPal and approve the payment or to a page to enter credit or debit card and other relevant billing information required to complete the purchase, depending on their previous interaction with PayPal.


 
shipping_preference
string (Order Application Context Shipping Preference)   [ 1 .. 20 ] characters ^[0-9A-Z_]+$
 Default:  "GET_FROM_FILE"
DEPRECATED. DEPRECATED. The shipping preference:
  • Displays the shipping address to the customer.
  • Enables the customer to choose an address on the PayPal site.
  • Restricts the customer from changing the address during the payment-approval process.
.  The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.shipping_preference). Please specify this field in the experience_context object instead of the application_context object.


 Enum Value Description
GET_FROM_FILE
Use the customer-provided shipping address on the PayPal site.


NO_SHIPPING
Redact the shipping address from the PayPal site. Recommended for digital goods.


SET_PROVIDED_ADDRESS
Use the merchant-provided address. The customer cannot change this address on the PayPal site.


 
user_action
string  [ 1 .. 8 ] characters ^[0-9A-Z_]+$
 Default:  "CONTINUE"
DEPRECATED. Configures a Continue or Pay Now checkout flow.  The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.user_action). Please specify this field in the experience_context object instead of the application_context object.


 Enum Value Description
CONTINUE
After you redirect the customer to the PayPal payment page, a Continue button appears. Use this option when the final amount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant page without processing the payment.


PAY_NOW
After you redirect the customer to the PayPal payment page, a Pay Now button appears. Use this option when the final amount is known when the checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now.


 
return_url
string <uri> 
DEPRECATED. The URL where the customer is redirected after the customer approves the payment. The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.return_url). Please specify this field in the experience_context object instead of the application_context object.


 
cancel_url
string <uri> 
DEPRECATED. The URL where the customer is redirected after the customer cancels the payment. The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.cancel_url). Please specify this field in the experience_context object instead of the application_context object.


 
locale
string <ppaas_common_language_v3>  (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
DEPRECATED. The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.  The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.locale). Please specify this field in the experience_context object instead of the application_context object.


 
object (payment_method) 
DEPRECATED. The customer and merchant payment preferences. The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.payment_method_selected). Please specify this field in the experience_context object instead of the application_context object..


 
object (stored_payment_source) 
DEPRECATED. Provides additional details to process a payment using a payment_source that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
  • payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
  • usage=FIRST is compatible only with payment_initiator=CUSTOMER.
  • previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
  • Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.
.  The fields in stored_payment_source are now available in the stored_credential object under the payment_source which supports them (eg. payment_source.card.stored_credential.payment_initiator). Please specify this field in the payment_source object instead of the application_context object.


 
{
  • "brand_name": "string",
  • "landing_page": "LOGIN",
  • "shipping_preference": "GET_FROM_FILE",
  • "user_action": "CONTINUE",
  • "return_url": "http://example.com",
  • "cancel_url": "http://example.com",
  • "locale": "string",
  • "payment_method": {
    • "standard_entry_class_code": "TEL",
    • "payee_preferred": "UNRESTRICTED"
    },
  • "stored_payment_source": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "acquirer_reference_number": "string",
      • "network": "VISA"
      }
    }
}
assurance_details
Information about cardholder possession validation and cardholder identification and verifications (ID&V).


account_verified
boolean
 Default:  false
If true, indicates that Cardholder possession validation has been performed on returned payment credential.


 
card_holder_authenticated
boolean
 Default:  false
If true, indicates that identification and verifications (ID&V) was performed on the returned payment credential.If false, the same risk-based authentication can be performed as you would for card transactions. This risk-based authentication can include, but not limited to, step-up with 3D Secure protocol if applicable.


 
{
  • "account_verified": false,
  • "card_holder_authenticated": false
}
authentication_response
Results of Authentication such as 3D Secure.


liability_shift
string (liability_shift)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Liability shift indicator. The outcome of the issuer's authentication.


 Enum Value Description
NO
Liability is with the merchant.


POSSIBLE
Liability may shift to the card issuer.


UNKNOWN
The authentication system is not available.


 
object (three_d_secure_authentication_response) 
Results of 3D Secure Authentication.


 
{
  • "liability_shift": "NO",
  • "three_d_secure": {
    • "authentication_status": "Y",
    • "enrollment_status": "Y"
    }
}
authorization
The authorized payment transaction.


status
string (Authorization Status) 
The status for the authorized payment.


 Enum Value Description
CREATED
The authorized payment is created. No captured payments have been made for this authorized payment.


CAPTURED
The authorized payment has one or more captures against it. The sum of these captured payments is greater than the amount of the original authorized payment.


DENIED
PayPal cannot authorize funds for this authorized payment.


PARTIALLY_CAPTURED
A captured payment was made for the authorized payment for an amount that is less than the amount of the original authorized payment.


VOIDED
The authorized payment was voided. No more captured payments can be made against this authorized payment.


PENDING
The created authorization is in pending state. For more information, see status.details.


 
object (authorization_status_details) 
The details of the authorized order pending status.


 
id
string
The PayPal-generated ID for the authorized payment.


 
invoice_id
string
The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.


 
custom_id
string  <= 255 characters 
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.


 
Array of objects (Link Description) 
An array of related HATEOAS links.


 
object (Money) 
The amount for this authorized payment.


 
object (network_transaction) 
Reference values used by the card network to identify a transaction.


 
object (seller_protection) 
The level of protection offered as defined by PayPal Seller Protection for Merchants.


 
expiration_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the authorized payment expires, in Internet date and time format.


 
create_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction occurred, in Internet date and time format.


 
update_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction was last updated, in Internet date and time format.


 
{
  • "status": "CREATED",
  • "status_details": {
    • "reason": "PENDING_REVIEW"
    },
  • "id": "string",
  • "invoice_id": "string",
  • "custom_id": "string",
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ],
  • "amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "network_transaction_reference": {
    • "id": "stringstr",
    • "date": "stri",
    • "acquirer_reference_number": "string",
    • "network": "VISA"
    },
  • "seller_protection": {
    • "status": "ELIGIBLE",
    • "dispute_categories": [
      • "string"
      ]
    },
  • "expiration_time": "string",
  • "create_time": "string",
  • "update_time": "string"
}
authorization_status
The status fields and status details for an authorized payment.


status
string (Authorization Status) 
The status for the authorized payment.


 Enum Value Description
CREATED
The authorized payment is created. No captured payments have been made for this authorized payment.


CAPTURED
The authorized payment has one or more captures against it. The sum of these captured payments is greater than the amount of the original authorized payment.


DENIED
PayPal cannot authorize funds for this authorized payment.


PARTIALLY_CAPTURED
A captured payment was made for the authorized payment for an amount that is less than the amount of the original authorized payment.


VOIDED
The authorized payment was voided. No more captured payments can be made against this authorized payment.


PENDING
The created authorization is in pending state. For more information, see status.details.


 
object (authorization_status_details) 
The details of the authorized order pending status.


 
{
  • "status": "CREATED",
  • "status_details": {
    • "reason": "PENDING_REVIEW"
    }
}
authorization_status_details
The details of the authorized payment status.


reason
string (Authorization Incomplete Reason)   [ 1 .. 64 ] characters ^[A-Z_]+$
The reason why the authorized status is PENDING.


 Enum Value Description
PENDING_REVIEW
Authorization is pending manual review.


DECLINED_BY_RISK_FRAUD_FILTERS
Risk Filter set by the payee failed for the transaction.


 
{
  • "reason": "PENDING_REVIEW"
}
authorization_with_additional_data
The authorization with additional payment details, such as risk assessment and processor response. These details are populated only for certain payment methods.


status
string (Authorization Status) 
The status for the authorized payment.


 Enum Value Description
CREATED
The authorized payment is created. No captured payments have been made for this authorized payment.


CAPTURED
The authorized payment has one or more captures against it. The sum of these captured payments is greater than the amount of the original authorized payment.


DENIED
PayPal cannot authorize funds for this authorized payment.


PARTIALLY_CAPTURED
A captured payment was made for the authorized payment for an amount that is less than the amount of the original authorized payment.


VOIDED
The authorized payment was voided. No more captured payments can be made against this authorized payment.


PENDING
The created authorization is in pending state. For more information, see status.details.


 
object (authorization_status_details) 
The details of the authorized order pending status.


 
id
string
The PayPal-generated ID for the authorized payment.


 
invoice_id
string
The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.


 
custom_id
string  <= 255 characters 
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.


 
Array of objects (Link Description) 
An array of related HATEOAS links.


 
object (Money) 
The amount for this authorized payment.


 
object (network_transaction) 
Reference values used by the card network to identify a transaction.


 
object (seller_protection) 
The level of protection offered as defined by PayPal Seller Protection for Merchants.


 
expiration_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the authorized payment expires, in Internet date and time format.


 
create_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction occurred, in Internet date and time format.


 
update_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction was last updated, in Internet date and time format.


 
object (processor_response) 
The processor response information for payment requests, such as direct credit card transactions.


 
{
  • "status": "CREATED",
  • "status_details": {
    • "reason": "PENDING_REVIEW"
    },
  • "id": "string",
  • "invoice_id": "string",
  • "custom_id": "string",
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ],
  • "amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "network_transaction_reference": {
    • "id": "stringstr",
    • "date": "stri",
    • "acquirer_reference_number": "string",
    • "network": "VISA"
    },
  • "seller_protection": {
    • "status": "ELIGIBLE",
    • "dispute_categories": [
      • "string"
      ]
    },
  • "expiration_time": "string",
  • "create_time": "string",
  • "update_time": "string",
  • "processor_response": {
    • "avs_code": "A",
    • "cvv_code": "E",
    • "response_code": "0000",
    • "payment_advice_code": "01"
    }
}
bancontact
Information used to pay Bancontact.


card_last_digits
string  = 4 characters [0-9]{4}
The last digits of the card used to fund the Bancontact payment.


 
name
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The bank identification code (BIC).


 
iban_last_chars
string (iban_last_chars)   [ 4 .. 34 ] characters [a-zA-Z0-9]{4}
The last characters of the IBAN used to pay.


 
{
  • "card_last_digits": "stri",
  • "name": "string",
  • "country_code": "string",
  • "bic": "string",
  • "iban_last_chars": "string"
}
bancontact_request
Information needed to pay using Bancontact.


name
required
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "experience_context": {
    • "brand_name": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "locale": "string",
    • "return_url": "string",
    • "cancel_url": "string"
    }
}
BIC
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.


string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.


 
"stringst"
Billing Cycle
The billing cycle providing details of the billing frequency, amount, duration and if the billing cycle is a free, discounted or regular billing cycle.


current_period
boolean
Indicates if this period, with its subscription terms, is currently active.


 
billing_interval_unit
string  [ 1 .. 24 ] characters ^[A-Z_]+$
The billing interval unit for the billing cycle.


 Enum Value Description
YEAR
The billing interval for the billing cycle is a year.


MONTH
The billing interval for the billing cycle is a month.


SEMIMONTH
The billing interval for the billing cycle is half a month.


WEEK
The billing interval for the billing cycle is a week.


DAY
The billing interval for the billing cycle is a day.


 
billing_frequency
integer  [ 1 .. 365 ] 
 Default:  1
The frequency, i.e. the number of billing interval units, at which the user is charged. E.g. - if the billing_interval_unit is DAY, with a billing_frequency of 2, the user is billed once every two days.


 
total_billing_cycles
integer  [ 0 .. 999 ] 
 Default:  1
The number of billing cycles in the period. This is effectively the number of times the user will be charged in the period.


 
current_billing_cycle
integer  [ 0 .. 999 ] 
Indicates the index of the current billing cycle for the period. E.g. - a value of 3 would mean that its the third billing cycle for the period.


 
regular_period
boolean
Indicates if the period is a regular period. A regular period would have standard billing cycle terms, as opposed to some special terms that might be applicable for a trial or promotional period.


 
id
string <ppaas_uuid_v3>  (uuid)   = 36 characters ^[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}...
The unique identifier for this billing cycle or recurring series.


 
create_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The create date and time for this billing cycle or recurring series.


 
update_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The update date and time for this billing cycle or recurring series.


 
object (Money) 
The amount that the user will be charged in each billing cycle.


 
object (Money) 
The shipping charges applicable for each cycle.


 
object (Money) 
The tax amount applicable for each cycle.


 
{
  • "current_period": true,
  • "billing_interval_unit": "YEAR",
  • "billing_frequency": 1,
  • "total_billing_cycles": 1,
  • "current_billing_cycle": 999,
  • "regular_period": true,
  • "id": "string",
  • "create_time": "string",
  • "update_time": "string",
  • "billing_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "shipping_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "tax_amount": {
    • "currency_code": "str",
    • "value": "string"
    }
}
billing_agreement_id
The PayPal billing agreement ID. References an approved recurring payment for goods or services.


string (billing_agreement_id)   [ 2 .. 128 ] characters ^[a-zA-Z0-9-]+$
The PayPal billing agreement ID. References an approved recurring payment for goods or services.


 
"string"
billing_cycle
The billing cycle providing details of the billing frequency, amount, duration and if the billing cycle is a free, discounted or regular billing cycle. The sequence of the billing cycle will be in the following order - free trial billing cycle(s), discounted trial billing cycle(s), regular billing cycle(s).


tenure_type
required
string  [ 1 .. 24 ] characters ^[A-Z_]+$
The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) or regular billing cycle.


 Enum Value Description
REGULAR
A regular billing cycle to identify recurring charges for the billing agreement.


TRIAL
A trial billing cycle to identify free or discounted charge for the billing agreement. Free trails will not have a price object in pricing scheme where as a discounted trial would have a discounted price compared to regular billing cycle.


 
total_cycles
integer <int32>   [ 0 .. 999 ] 
 Default:  1
The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).


 
sequence
integer <int32>   [ 1 .. 3 ] 
 Default:  1
The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a sequence of 1 while a regular billing cycle has a sequence of 2, so that trial cycle runs before the regular cycle.


 
object (pricing_scheme) 
The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme.


 
start_date
string <ppaas_date_notime_v2>  (date_no_time)   = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The start date for the billing cycle, in YYYY-MM-DD. This field should be not be provided if the billing cycle starts at the time of checkout. When this field is not provided, the billing cycle amount will be included in any data validations confirming that the total provided by the merchant match the sum of individual items due at the time of checkout. Only one billing cycle (with sequence equal to 1) can have a no start date.


 
{
  • "tenure_type": "REGULAR",
  • "total_cycles": 1,
  • "sequence": 1,
  • "pricing_scheme": {
    • "pricing_model": "FIXED",
    • "price": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "reload_threshold_amount": {
      • "currency_code": "str",
      • "value": "string"
      }
    },
  • "start_date": "string"
}
bin_details
Bank Identification Number (BIN) details used to fund a payment.


bin
string  [ 1 .. 25 ] characters ^[0-9]+$
The Bank Identification Number (BIN) signifies the number that is being used to identify the granular level details (except the PII information) of the card.


 
issuing_bank
string  [ 1 .. 64 ] characters 
The issuer of the card instrument.


 
products
Array of strings  [ 1 .. 256 ] items 
The type of card product assigned to the BIN by the issuer. These values are defined by the issuer and may change over time. Some examples include: PREPAID_GIFT, CONSUMER, CORPORATE.


 
bin_country_code
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
 
{
  • "bin": "string",
  • "issuing_bank": "string",
  • "products": [
    • "string"
    ],
  • "bin_country_code": "string"
}
blik
Information used to pay using BLIK.


name
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
email
string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The email address of the account holder associated with this payment method.


 
object (blik_one_click_response) 
The one-click integration flow object.


 
{
  • "name": "string",
  • "country_code": "string",
  • "email": "string",
  • "one_click": {
    • "consumer_reference": "string"
    }
}
blik_experience_context
Customizes the payer experience during the approval process for the BLIK payment.


brand_name
string  [ 1 .. 127 ] characters ^.*$
The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.


 
shipping_preference
string  [ 1 .. 24 ] characters ^[A-Z_]+$
 Default:  "GET_FROM_FILE"
The location from which the shipping address is derived.


 Enum Value Description
GET_FROM_FILE
Get the customer-provided shipping address on the PayPal site.


NO_SHIPPING
Redacts the shipping address from the PayPal site. Recommended for digital goods.


SET_PROVIDED_ADDRESS
Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages.


 
locale
string <ppaas_common_language_v3>  (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.


 
return_url
string <uri>  (url) 
The URL where the customer is redirected after the customer approves the payment.


 
cancel_url
string <uri>  (url) 
The URL where the customer is redirected after the customer cancels the payment.


 
consumer_user_agent
string  [ 1 .. 256 ] characters ^.*$
The payer's User Agent. For example, Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0).


 
consumer_ip
string <ppaas_ip_address_v1>  (IP Address)   [ 7 .. 39 ] characters ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...
The IP address of the consumer. It could be either IPv4 or IPv6.


 
{
  • "brand_name": "string",
  • "shipping_preference": "GET_FROM_FILE",
  • "locale": "string",
  • "return_url": "string",
  • "cancel_url": "string",
  • "consumer_user_agent": "string",
  • "consumer_ip": "string"
}
blik_level_0
Information used to pay using BLIK level_0 flow.


auth_code
required
string  = 6 characters ^[0-9]{6}$
The 6-digit code used to authenticate a consumer within BLIK.


 
{
  • "auth_code": "string"
}
blik_one_click
Information used to pay using BLIK one-click flow.


auth_code
string  = 6 characters ^[0-9]{6}$
The 6-digit code used to authenticate a consumer within BLIK.


 
consumer_reference
required
string  [ 3 .. 64 ] characters ^[ -~]{3,64}$
The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.


 
alias_label
string  [ 8 .. 35 ] characters ^[ -~]{8,35}$
A bank defined identifier used as a display name to allow the payer to differentiate between multiple registered bank accounts.


 
alias_key
string  [ 1 .. 19 ] characters ^[0-9]+$
A Blik-defined identifier for a specific Blik-enabled bank account that is associated with a given merchant. Used only in conjunction with a Consumer Reference.


 
{
  • "auth_code": "string",
  • "consumer_reference": "string",
  • "alias_label": "stringst",
  • "alias_key": "string"
}
blik_one_click_response
Information used to pay using BLIK one-click flow.


consumer_reference
string  [ 3 .. 64 ] characters ^[ -~]{3,64}$
The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.


 
{
  • "consumer_reference": "string"
}
blik_request
Information needed to pay using BLIK.


name
required
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
email
string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The email address of the account holder associated with this payment method.


 
object (blik_experience_context) 
Customizes the payer experience during the approval process for the payment.


 
object (blik_level_0) 
The level_0 integration flow object.


 
object (blik_one_click) 
The one-click integration flow object.


 
{
  • "name": "string",
  • "country_code": "string",
  • "email": "string",
  • "experience_context": {
    • "brand_name": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "locale": "string",
    • "return_url": "string",
    • "cancel_url": "string",
    • "consumer_user_agent": "string",
    • "consumer_ip": "string"
    },
  • "level_0": {
    • "auth_code": "string"
    },
  • "one_click": {
    • "auth_code": "string",
    • "consumer_reference": "string",
    • "alias_label": "stringst",
    • "alias_key": "string"
    }
}
callback_configuration
CallBack Configuration that the merchant can provide to PayPal/Venmo.


callback_events
required
Array of strings  [ 1 .. 5 ] items  unique 
An array of callback events merchant can subscribe to for the corresponding callback url.


 
callback_url
required
string <uri>   [ 10 .. 2040 ] characters ^.*$
Merchant provided CallBack url.PayPal/Venmo will use this url to call the merchant back when the events occur .PayPal/Venmo expects a secured url usually in the https format.merchant can append the cart id or other params part of the url as query or path params.


 
{}
capture
A captured payment.


create_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction occurred, in Internet date and time format.


 
update_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction was last updated, in Internet date and time format.


 
id
string
The PayPal-generated ID for the captured payment.


 
invoice_id
string
The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.


 
custom_id
string  <= 255 characters 
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.


 
final_capture
boolean
 Default:  false
Indicates whether you can make additional captures against the authorized payment. Set to true if you do not intend to capture additional payments against the authorization. Set to false if you intend to capture additional payments against the authorization.


 
Array of objects (Link Description) 
An array of related HATEOAS links.


 
object (Money) 
The amount for this captured payment.


 
object (network_transaction) 
Reference values used by the card network to identify a transaction.


 
object (seller_protection) 
The level of protection offered as defined by PayPal Seller Protection for Merchants.


 
object (Seller Receivable Breakdown) 
The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.


 
disbursement_mode
string (disbursement_mode)   [ 1 .. 16 ] characters ^[A-Z_]+$
 Default:  "INSTANT"
The funds that are held on behalf of the merchant.


 Enum Value Description
INSTANT
The funds are released to the merchant immediately.


DELAYED
The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration.


 
object (processor_response) 
An object that provides additional processor information for a direct credit card transaction.


 
{
  • "create_time": "string",
  • "update_time": "string",
  • "id": "string",
  • "invoice_id": "string",
  • "custom_id": "string",
  • "final_capture": false,
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ],
  • "amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "network_transaction_reference": {
    • "id": "stringstr",
    • "date": "stri",
    • "acquirer_reference_number": "string",
    • "network": "VISA"
    },
  • "seller_protection": {
    • "status": "ELIGIBLE",
    • "dispute_categories": [
      • "string"
      ]
    },
  • "seller_receivable_breakdown": {
    • "platform_fees": [
      • {
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "payee": {
          • "email_address": "string",
          • "merchant_id": "string"
          }
        }
      ],
    • "gross_amount": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "paypal_fee": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "paypal_fee_in_receivable_currency": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "net_amount": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "receivable_amount": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "exchange_rate": {
      • "value": "string",
      • "source_currency": "str",
      • "target_currency": "str"
      }
    },
  • "disbursement_mode": "INSTANT",
  • "processor_response": {
    • "avs_code": "A",
    • "cvv_code": "E",
    • "response_code": "0000",
    • "payment_advice_code": "01"
    }
}
capture_status
The status and status details of a captured payment.


status
string (Capture Status) 
The status of the captured payment.


 Enum Value Description
COMPLETED
The funds for this captured payment were credited to the payee's PayPal account.


DECLINED
The funds could not be captured.


PARTIALLY_REFUNDED
An amount less than this captured payment's amount was partially refunded to the payer.


PENDING
The funds for this captured payment was not yet credited to the payee's PayPal account. For more information, see status.details.


REFUNDED
An amount greater than or equal to this captured payment's amount was refunded to the payer.


FAILED
There was an error while capturing payment.


 
object (capture_status_details) 
The details of the captured payment status.


 
{
  • "status": "COMPLETED",
  • "status_details": {
    • "reason": "BUYER_COMPLAINT"
    }
}
capture_status_details
The details of the captured payment status.


reason
string (Capture Incomplete Reason)   [ 1 .. 64 ] characters ^[A-Z_]+$
The reason why the captured payment status is PENDING or DENIED.


 Enum Value Description
BUYER_COMPLAINT
The payer initiated a dispute for this captured payment with PayPal.


CHARGEBACK
The captured funds were reversed in response to the payer disputing this captured payment with the issuer of the financial instrument used to pay for this captured payment.


ECHECK
The payer paid by an eCheck that has not yet cleared.


INTERNATIONAL_WITHDRAWAL
Visit your online account. In your Account Overview, accept and deny this payment.


OTHER
No additional specific reason can be provided. For more information about this captured payment, visit your account online or contact PayPal.


PENDING_REVIEW
The captured payment is pending manual review.


RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION
The payee has not yet set up appropriate receiving preferences for their account. For more information about how to accept or deny this payment, visit your account online. This reason is typically offered in scenarios such as when the currency of the captured payment is different from the primary holding currency of the payee.


REFUNDED
The captured funds were refunded.


TRANSACTION_APPROVED_AWAITING_FUNDING
The payer must send the funds for this captured payment. This code generally appears for manual EFTs.


UNILATERAL
The payee does not have a PayPal account.


VERIFICATION_REQUIRED
The payee's PayPal account is not verified.


DECLINED_BY_RISK_FRAUD_FILTERS
Risk Filter set by the payee failed for the transaction.


 
{
  • "reason": "BUYER_COMPLAINT"
}
card
The payment card to use to fund a payment. Can be a credit or debit card.


name
string  [ 1 .. 300 ] characters ^.{1,300}$
The card holder's name as it appears on the card.


 
number
string  [ 13 .. 19 ] characters ^[0-9]{13,19}$
The primary account number (PAN) for the payment card.


 
security_code
string  [ 3 .. 4 ] characters ^[0-9]{3,4}$
The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when payment_initiator=MERCHANT.


 
expiry
string (date_year_month)   = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format For example: 2028-04


 
object (Portable Postal Address (Medium-Grained)) 
The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.


 
object (card_attributes) 
Additional attributes associated with the use of this card.


 
{
  • "name": "string",
  • "number": "stringstrings",
  • "security_code": "stri",
  • "expiry": "string",
  • "billing_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    },
  • "attributes": {
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        },
      • "merchant_customer_id": "string"
      },
    • "vault": {
      • "store_in_vault": "ON_SUCCESS"
      },
    • "verification": {
      • "method": "SCA_ALWAYS"
      }
    }
}
card
The payment card to use to fund a payment. Can be a credit or debit card.


name
string  [ 1 .. 300 ] characters ^.{1,300}$
The card holder's name as it appears on the card.


 
number
string  [ 13 .. 19 ] characters ^[0-9]{13,19}$
The primary account number (PAN) for the payment card.


 
expiry
string (date_year_month)   = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format For example: 2028-04


 
card_type
string (card_brand)   [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.


 Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
type
string (card_type)   [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.


 Enum Value Description
CREDIT
A credit card.


DEBIT
A debit card.


PREPAID
A Prepaid card.


STORE
A store card.


UNKNOWN
Card type cannot be determined.


 
brand
string (card_brand)   [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.


 Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
object (Portable Postal Address (Medium-Grained)) 
The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.


 
{
  • "name": "string",
  • "number": "stringstrings",
  • "expiry": "string",
  • "card_type": "VISA",
  • "type": "CREDIT",
  • "brand": "VISA",
  • "billing_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    }
}
Card Verification
The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS).


method
string  [ 1 .. 255 ] characters ^[0-9A-Z_]+$
 Default:  "SCA_WHEN_REQUIRED"
The method used for card verification.


 Enum Value Description
SCA_ALWAYS
Selecting this option will attempt to force a strong customer authentication for the authorization/transaction. In countries where SCA has been defined and implemented it will result in a contingency and HATEOAS link being returned.  The API caller should redirect the payer to that link so that they can authenticate themselves against their issuing bank or other entity. As noted, the HATEOAS link is only available in all regions where strong authentication is supported, (e.g. in European countries where 3DS is live). Merchants can use this setting as an additional layer of security if they choose to. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response.


SCA_WHEN_REQUIRED
This is the default. When an authorization or transaction is attempted this option will return a contingency and HATEOAS link only when local regulations require strong customer authentication, (e.g. 3DS in countries and use cases where it is mandated). The API caller should redirect the payer to the link so that they can authenticate themselves. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response.


3D_SECURE
The contingency surfaced as an additional security layer that helps prevent unauthorized card-not-present transactions and protects the merchant from exposure to fraud.


AVS_CVV
Places a temporary hold on the card to ensure its validity. This process protects the merchant from exposure to fraud. This verification method will confirm that the address information or CVV included matches what the issuing bank has on file for the associated card, ensuring that only authorized card users are able to make purchases from you.


 
{
  • "method": "SCA_ALWAYS"
}
card_attributes
Additional attributes associated with the use of this card.


object (card_customer) 
The details about a customer in PayPal's system of record.


 
object (vault_instruction_base) 
Instruction to vault the card based on the specified strategy.


 
object (Card Verification) 
Instruction to optionally verify the card based on the specified strategy.


 
{
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "merchant_customer_id": "string"
    },
  • "vault": {
    • "store_in_vault": "ON_SUCCESS"
    },
  • "verification": {
    • "method": "SCA_ALWAYS"
    }
}
card_attributes_response
Additional attributes associated with the use of this card.


object (card_vault_response) 
The details about a saved Card payment source.


 
{
  • "vault": {
    • "id": "string",
    • "status": "VAULTED",
    • "links": [
      • {
        • "href": "string",
        • "rel": "string",
        • "method": "GET"
        }
      ],
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        },
      • "merchant_customer_id": "string"
      }
    }
}
card_brand
The card network or brand. Applies to credit, debit, gift, and payment cards.


string (card_brand)   [ 1 .. 255 ] characters ^[A-Z_]+$
The card network or brand. Applies to credit, debit, gift, and payment cards.


 Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
"VISA"
card_customer
The details about a customer in PayPal's system of record.


id
string (merchant_partner_customer_id)   [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.


 
email_address
string <merchant_common_email_address_v2>  (email)   [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...
Email address of the customer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants.


 
object (phone_with_type) 
The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.


 
object (Name) 
The full name of the customer as provided to the merchant or on file with the merchant.


 
merchant_customer_id
string  [ 1 .. 64 ] characters ^[0-9a-zA-Z-_.^*$@#]+$
Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.


 
{
  • "id": "string",
  • "email_address": "string",
  • "phone": {
    • "phone_type": "FAX",
    • "phone_number": {
      • "national_number": "string"
      }
    },
  • "name": {
    • "given_name": "string",
    • "surname": "string"
    },
  • "merchant_customer_id": "string"
}
card_experience_context
Customizes the payer experience during the 3DS Approval for payment.


return_url
string <uri>  (url)   [ 10 .. 4000 ] characters 
The URL where the customer will be redirected upon successfully completing the 3DS challenge.


 
cancel_url
string <uri>  (url)   [ 10 .. 4000 ] characters 
The URL where the customer will be redirected upon cancelling the 3DS challenge.


 
{
  • "return_url": "string",
  • "cancel_url": "string"
}
card_from_request
Representation of card details as received in the request.


last_digits
string  [ 2 .. 4 ] characters [0-9]{2,}
The last digits of the payment card.


 
expiry
string (date_year_month)   = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format.


 
{
  • "last_digits": "stri",
  • "expiry": "string"
}
card_request
The payment card to use to fund a payment. Can be a credit or debit card.
Note: Passing card number, cvv and expiry directly via the API requires  PCI SAQ D compliance. 
PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide.


name
string  [ 1 .. 300 ] characters ^.{1,300}$
The card holder's name as it appears on the card.


 
number
string  [ 13 .. 19 ] characters ^[0-9]{13,19}$
The primary account number (PAN) for the payment card.


 
security_code
string  [ 3 .. 4 ] characters ^[0-9]{3,4}$
The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when payment_initiator=MERCHANT.


 
expiry
string (date_year_month)   = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format For example: 2028-04


 
object (Portable Postal Address (Medium-Grained)) 
The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.


 
object (card_attributes) 
Additional attributes associated with the use of this card.


 
object (card_stored_credential) 
Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
  • payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
  • usage=FIRST is compatible only with payment_initiator=CUSTOMER.
  • previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
  • Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.


 
vault_id
string (vault_id)   [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the saved card payment source. Typically stored on the merchant's server.


 
single_use_token
string (single_use_token)   [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated, short-lived, one-time-use token, used to communicate payment information to PayPal for transaction processing.


 
object (network_token) 
A 3rd party network token refers to a network token that the merchant provisions from and vaults with an external TSP (Token Service Provider) other than PayPal.


 
object (card_experience_context) 
Customizes the payer experience during the 3DS Approval for payment.


 
{
  • "name": "string",
  • "number": "stringstrings",
  • "security_code": "stri",
  • "expiry": "string",
  • "billing_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    },
  • "attributes": {
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        },
      • "merchant_customer_id": "string"
      },
    • "vault": {
      • "store_in_vault": "ON_SUCCESS"
      },
    • "verification": {
      • "method": "SCA_ALWAYS"
      }
    },
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "acquirer_reference_number": "string",
      • "network": "VISA"
      }
    },
  • "vault_id": "string",
  • "single_use_token": "string",
  • "network_token": {
    • "number": "stringstrings",
    • "cryptogram": "stringstringstringstringstri",
    • "token_requestor_id": "string",
    • "expiry": "string",
    • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION"
    },
  • "experience_context": {
    • "return_url": "string",
    • "cancel_url": "string"
    }
}
card_response
The payment card to use to fund a payment. Card can be a credit or debit card.


name
string  [ 2 .. 300 ] characters 
The card holder's name as it appears on the card.


 
last_digits
string[0-9]{2,}
The last digits of the payment card.


 
available_networks
Array of strings (card_brand)   [ 1 .. 256 ] items 
Array of brands or networks associated with the card.


Items Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
object (card_from_request) 
Representation of card details as received in the request.


 
object (card_stored_credential) 
Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
  • payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
  • usage=FIRST is compatible only with payment_initiator=CUSTOMER.
  • previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
  • Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.


 
brand
string (card_brand)   [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.


 Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
type
string (card_type)   [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.


 Enum Value Description
CREDIT
A credit card.


DEBIT
A debit card.


PREPAID
A Prepaid card.


STORE
A store card.


UNKNOWN
Card type cannot be determined.


 
object (authentication_response) 
Results of Authentication such as 3D Secure.


 
object (card_attributes_response) 
Additional attributes associated with the use of this card.


 
expiry
string (date_year_month)   = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format.


 
object (bin_details) 
Bank Identification Number (BIN) details used to fund a payment.


 
{
  • "name": "string",
  • "last_digits": "string",
  • "available_networks": [
    • "VISA"
    ],
  • "from_request": {
    • "last_digits": "stri",
    • "expiry": "string"
    },
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "acquirer_reference_number": "string",
      • "network": "VISA"
      }
    },
  • "brand": "VISA",
  • "type": "CREDIT",
  • "authentication_result": {
    • "liability_shift": "NO",
    • "three_d_secure": {
      • "authentication_status": "Y",
      • "enrollment_status": "Y"
      }
    },
  • "attributes": {
    • "vault": {
      • "id": "string",
      • "status": "VAULTED",
      • "links": [
        • {
          • "href": "string",
          • "rel": "string",
          • "method": "GET"
          }
        ],
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          },
        • "merchant_customer_id": "string"
        }
      }
    },
  • "expiry": "string",
  • "bin_details": {
    • "bin": "string",
    • "issuing_bank": "string",
    • "products": [
      • "string"
      ],
    • "bin_country_code": "string"
    }
}
card_response
The payment card to use to fund a payment. Card can be a credit or debit card.


name
string  [ 2 .. 300 ] characters 
The card holder's name as it appears on the card.


 
last_digits
string[0-9]{2,}
The last digits of the payment card.


 
available_networks
Array of strings (card_brand)   [ 1 .. 256 ] items 
Array of brands or networks associated with the card.


Items Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
object (card_from_request) 
Representation of card details as received in the request.


 
object (card_stored_credential) 
Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
  • payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
  • usage=FIRST is compatible only with payment_initiator=CUSTOMER.
  • previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
  • Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.


 
brand
string (card_brand)   [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.


 Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
type
string (card_type)   [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.


 Enum Value Description
CREDIT
A credit card.


DEBIT
A debit card.


PREPAID
A Prepaid card.


STORE
A store card.


UNKNOWN
Card type cannot be determined.


 
object (authentication_response) 
Results of Authentication such as 3D Secure.


 
object (card_attributes_response) 
Additional attributes associated with the use of this card.


 
expiry
string (date_year_month)   = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format.


 
object (bin_details) 
Bank Identification Number (BIN) details used to fund a payment.


 
{
  • "name": "string",
  • "last_digits": "string",
  • "available_networks": [
    • "VISA"
    ],
  • "from_request": {
    • "last_digits": "stri",
    • "expiry": "string"
    },
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "acquirer_reference_number": "string",
      • "network": "VISA"
      }
    },
  • "brand": "VISA",
  • "type": "CREDIT",
  • "authentication_result": {
    • "liability_shift": "NO",
    • "three_d_secure": {
      • "authentication_status": "Y",
      • "enrollment_status": "Y"
      }
    },
  • "attributes": {
    • "vault": {
      • "id": "string",
      • "status": "VAULTED",
      • "links": [
        • {
          • "href": "string",
          • "rel": "string",
          • "method": "GET"
          }
        ],
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          },
        • "merchant_customer_id": "string"
        }
      }
    },
  • "expiry": "string",
  • "bin_details": {
    • "bin": "string",
    • "issuing_bank": "string",
    • "products": [
      • "string"
      ],
    • "bin_country_code": "string"
    }
}
card_stored_credential
Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
  • payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
  • usage=FIRST is compatible only with payment_initiator=CUSTOMER.
  • previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
  • Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.


payment_initiator
required
string (payment_initiator)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The person or party who initiated or triggered the payment.


 Enum Value Description
CUSTOMER
Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website.


MERCHANT
Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer.


 
payment_type
required
string (stored_payment_source_payment_type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Indicates the type of the stored payment_source payment.


 Enum Value Description
ONE_TIME
One Time payment such as online purchase or donation. (e.g. Checkout with one-click).


RECURRING
Payment which is part of a series of payments with fixed or variable amounts, following a fixed time interval. (e.g. Subscription payments).


UNSCHEDULED
Payment which is part of a series of payments that occur on a non-fixed schedule and/or have variable amounts. (e.g. Account Topup payments).


 
usage
string (stored_payment_source_usage_type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
 Default:  "DERIVED"
Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).


 Enum Value Description
FIRST
Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment.


SUBSEQUENT
Indicates a payment using a stored payment_source which has been successfully used previously for a payment.


DERIVED
Indicates that PayPal will derive the value of FIRST or SUBSEQUENT based on data available to PayPal.


 
object (network_transaction_reference) 
Reference values used by the card network to identify a transaction.


 
{
  • "payment_initiator": "CUSTOMER",
  • "payment_type": "ONE_TIME",
  • "usage": "FIRST",
  • "previous_network_transaction_reference": {
    • "id": "stringstr",
    • "date": "stri",
    • "acquirer_reference_number": "string",
    • "network": "VISA"
    }
}
card_supplementary_data
Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.


object (level_2) 
The level 2 card processing data collections. If your merchant account has been configured for Level 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 2 data for your business.


 
object (level_3) 
The level 3 card processing data collections, If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 3 data for your business.


 
{
  • "level_2": {
    • "invoice_id": "string",
    • "tax_total": {
      • "currency_code": "str",
      • "value": "string"
      }
    },
  • "level_3": {
    • "ships_from_postal_code": "string",
    • "line_items": [
      • {
        • "name": "string",
        • "quantity": "string",
        • "description": "string",
        • "sku": "string",
        • "url": "http://example.com",
        • "image_url": "http://example.com",
        • "upc": {
          • "type": "UPC-A",
          • "code": "string"
          },
        • "billing_plan": {
          • "billing_cycles": [
            • {
              • "tenure_type": "REGULAR",
              • "total_cycles": 1,
              • "sequence": 1,
              • "pricing_scheme": {
                • "pricing_model": null,
                • "price": null,
                • "reload_threshold_amount": null
                },
              • "start_date": "string"
              }
            ],
          • "name": "string",
          • "setup_fee": {
            • "currency_code": "str",
            • "value": "string"
            }
          },
        • "commodity_code": "string",
        • "unit_of_measure": "string",
        • "unit_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "tax": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "discount_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "total_amount": {
          • "currency_code": "str",
          • "value": "string"
          }
        }
      ],
    • "shipping_amount": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "duty_amount": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "discount_amount": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "shipping_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      }
    }
}
card_type
Type of card. i.e Credit, Debit and so on.


string (card_type)   [ 1 .. 255 ] characters ^[A-Z_]+$
Type of card. i.e Credit, Debit and so on.


 Enum Value Description
CREDIT
A credit card.


DEBIT
A debit card.


PREPAID
A Prepaid card.


STORE
A store card.


UNKNOWN
Card type cannot be determined.


 
"CREDIT"
card_vault_response
The details about a saved Card payment source.


id
string  [ 1 .. 255 ] characters 
The PayPal-generated ID for the saved payment source.


 
status
string (Vault Status)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The vault status.


 Enum Value Description
VAULTED
The payment source has been saved in your customer's vault. This vault status reflects /v3/vault status.


CREATED
DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations.


APPROVED
Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault


 
Array of objects (Link Description)   [ 1 .. 10 ] items 
An array of request-related HATEOAS links.


 
object (card_customer) 
The details about a customer in PayPal's system of record.


 
{
  • "id": "string",
  • "status": "VAULTED",
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ],
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "merchant_customer_id": "string"
    }
}
carrier
The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier to OTHER and set carrier name in carrier_name_other. For allowed values, see Carriers.


string (carrier)   [ 1 .. 64 ] characters ^[0-9A-Z_]+$
The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier to OTHER and set carrier name in carrier_name_other. For allowed values, see Carriers.


 Enum Value Description
DPD_RU
DPD Russia.


BG_BULGARIAN_POST
Bulgarian Posts.


KR_KOREA_POST
Koreapost (www.koreapost.go.kr).


ZA_COURIERIT
Courier IT.


FR_EXAPAQ
DPD France (formerly exapaq).


ARE_EMIRATES_POST
Emirates Post.


GAC
GAC.


GEIS
Geis CZ.


SF_EX
SF Express.


PAGO
Pago Logistics.


MYHERMES
MyHermes UK.


DIAMOND_EUROGISTICS
Diamond Eurogistics Limited.


CORPORATECOURIERS_WEBHOOK
Corporate Couriers.


BOND
Bond courier.


OMNIPARCEL
Omni Parcel.


SK_POSTA
Slovenska pošta.


PUROLATOR
purolator.


FETCHR_WEBHOOK
Mena 360 (Fetchr).


THEDELIVERYGROUP
TDG – The Delivery Group.


CELLO_SQUARE
Cello Square.


TARRIVE
TONDA GLOBAL.


COLLIVERY
MDS Collivery Pty (Ltd).


MAINFREIGHT
Mainfreight.


IND_FIRSTFLIGHT
First Flight Couriers.


ACSWORLDWIDE
ACS Worldwide Express.


AMSTAN
Amstan Logistics.


OKAYPARCEL
OkayParcel.


ENVIALIA_REFERENCE
Envialia Reference.


SEUR_ES
Seur Spain.


CONTINENTAL
Continental.


FDSEXPRESS
FDSEXPRESS.


AMAZON_FBA_SWISHIP
Swiship UK.


WYNGS
Wyngs.


DHL_ACTIVE_TRACING
DHL Active Tracing.


ZYLLEM
Zyllem.


RUSTON
Ruston.


XPOST
Xpost.ph.


CORREOS_ES
correos Express (www.correos.es).


DHL_FR
DHL France (www.dhl.com).


PAN_ASIA
Pan-Asia International.


BRT_IT
BRT couriers Italy (www.brt.it).


SRE_KOREA
SRE Korea (www.srekorea.co.kr).


SPEEDEE
Spee-Dee Delivery.


TNT_UK
TNT UK Limited (www.tnt.com).


VENIPAK
Venipak.


SHREENANDANCOURIER
SHREE NANDAN COURIER.


CROSHOT
Croshot.


NIPOST_NG
NIpost (www.nipost.gov.ng).


EPST_GLBL
ePost Global.


NEWGISTICS
Newgistics.


POST_SLOVENIA
Post of Slovenia.


JERSEY_POST
Jersey Post.


BOMBINOEXP
Bombino Express Pvt.


WMG
WMG Delivery.


XQ_EXPRESS
XQ Express.


FURDECO
Furdeco.


LHT_EXPRESS
LHT Express.


SOUTH_AFRICAN_POST_OFFICE
South African Post Office.


SPOTON
SPOTON Logistics Pvt Ltd.


DIMERCO
Dimerco Express Group.


CYPRUS_POST_CYP
cyprus post.


ABCUSTOM
AB Custom Group.


IND_DELIVREE
deliverE.


CN_BESTEXPRESS
Best Express.


DX_SFTP
DX (SFTP).


PICKUPP_MYS
PICK UPP.


FMX
FMX.


HELLMANN
Hellmann Worldwide Logistics.


SHIP_IT_ASIA
Ship It Asia.


KERRY_ECOMMERCE
Kerry eCommerce.


FRETERAPIDO
Frete Rapido.


PITNEY_BOWES
Pitney Bowes.


XPRESSEN_DK
Xpressen courier.


SEUR_SP_API
Spanish Seur API.


DELIVERYONTIME
DELIVERYONTIME LOGISTICS PVT LTD.


JINSUNG
JINSUNG TRADING.


TRANS_KARGO
Trans Kargo Internasional.


SWISHIP_DE
Swiship DE.


IVOY_WEBHOOK
Ivoy courier.


AIRMEE_WEBHOOK
Airmee couriers.


DHL_BENELUX
dhl benelux.


FIRSTMILE
FirstMile.


FASTWAY_IR
Fastway Ireland.


HH_EXP
Hua Han Logistics.


MYS_MYPOST_ONLINE
Mypostonline.


TNT_NL
THT Netherland.


TIPSA
TIPSA courier.


TAQBIN_MY
TAQBIN Malaysia.


KGMHUB
KGM Hub.


INTEXPRESS
Internet Express.


OVERSE_EXP
Overseas Express.


ONECLICK
One click delivery services.


ROADRUNNER_FREIGHT
Roadbull Logistics.


GLS_CROTIA
GLS Croatia.


MRW_FTP
MRW courier.


BLUEX
Blue Express.


DYLT
Daylight Transport.


DPD_IR
DPD Ireland.


SIN_GLBL
Sin Global Express.


TUFFNELLS_REFERENCE
Tuffnells Parcels Express- Reference.


CJPACKET
CJ Packet.


MILKMAN
Milkman courier.


ASIGNA
ASIGNA courier.


ONEWORLDEXPRESS
One World Express.


ROYAL_MAIL
RoyalShipments.


VIA_EXPRESS
Viaxpress.


TIGFREIGHT
TIG Freight.


ZTO_EXPRESS
ZTO Express.


TWO_GO
2GO Courier.


IML
IML courier.


INTEL_VALLEY
Intel-Valley Supply chain (ShenZhen) Co. Ltd.


EFS
EFS (E-commerce Fulfillment Service).


UK_UK_MAIL
UK mail (ukmail.com).


RAM
RAM courier.


ALLIEDEXPRESS
Allied Express.


APC_OVERNIGHT
APC overnight (apc-overnight.com).


SHIPPIT
Shippit.


TFM
TFM Xpress.


M_XPRESS
M Xpress Sdn Bhd.


HDB_BOX
Haidaibao (BOX).


CLEVY_LINKS
Clevy Links.


IBEONE
Beone Logistics.


FIEGE_NL
Fiege Netherlands.


KWE_GLOBAL
KWE Global.


CTC_EXPRESS
CTC Express.


AMAZON
Amazon Shipping.


MORE_LINK
Morelink.


JX
JX courier.


EASY_MAIL
Easy Mail.


ADUIEPYLE
A Duie Pyle.


GB_PANTHER
Panther.


EXPRESSSALE
Expresssale.


SG_DETRACK
Detrack.


TRUNKRS_WEBHOOK
Trunkrs courier.


MATDESPATCH
Matdespatch.


DICOM
GLS Logistic Systems Canada Ltd./Dicom.


MBW
MBW Courier Inc..


KHM_CAMBODIA_POST
Cambodia Post.


SINOTRANS
Sinotrans.


BRT_IT_PARCELID
BRT Bartolini(Parcel ID).


DHL_SUPPLY_CHAIN
DHL Supply Chain APAC.


DHL_PL
DHL Poland.


TOPYOU
TopYou.


PALEXPRESS
PAL Express Limited.


DHL_SG
dhl Singapore.


CN_WEDO
WeDo Logistics.


FULFILLME
Fulfillme.


DPD_DELISTRACK
DPD delistrack.


UPS_REFERENCE
UPS Reference.


CARIBOU
Caribou.


LOCUS_WEBHOOK
Locus courier.


DSV
DSV courier.


P2P_TRC
P2P TrakPak.


DIRECTPARCELS
Direct Parcels.


NOVA_POSHTA_INT
Nova Poshta (International).


FEDEX_POLAND
FedEx® Poland Domestic.


CN_JCEX
JCEX courier.


FAR_INTERNATIONAL
FAR international.


IDEXPRESS
IDEX courier.


GANGBAO
GANGBAO Supplychain.


NEWAY
Neway Transport.


POSTNL_INT_3_S
PostNL International.


RPX_ID
RPX Indonesia.


DESIGNERTRANSPORT_WEBHOOK
Designer Transport.


GLS_SLOVEN
GLS Slovenia.


PARCELLED_IN
Parcelled.in.


GSI_EXPRESS
GSI EXPRESS.


CON_WAY
Con-way Freight.


BROUWER_TRANSPORT
Brouwer Transport en Logistiek.


CPEX
Captain Express International.


ISRAEL_POST
Israel Post.


DTDC_IN
DTDC India.


PTT_POST
PTT Post.


XDE_WEBHOOK
Ximex Delivery Express.


TOLOS
Tolos courier.


GIAO_HANG
Giao hàng nhanh.


GEODIS_ESPACE
Geodis E-space.


MAGYAR_HU
Magyar Post.


DOORDASH_WEBHOOK
DoorDash.


TIKI_ID
Tiki shipment.


CJ_HK_INTERNATIONAL
CJ Logistics International(Hong Kong).


STAR_TRACK_EXPRESS
Star Track Express.


HELTHJEM
Helthjem.


SFB2C
SF International.


FREIGHTQUOTE
Freightquote by C.H. Robinson.


LANDMARK_GLOBAL_REFERENCE
Landmark Global Reference.


PARCEL2GO
Parcel2Go.


DELNEXT
Delnext.


RCL
Red Carpet Logistics.


CGS_EXPRESS
CGS Express.


HK_POST
Hongkong Post (www.hongkongpost.hk).


SAP_EXPRESS
SAP EXPRESS.


PARCELPOST_SG
Parcel Post Singapore.


HERMES
HermesWorld UK.


IND_SAFEEXPRESS
Safexpress.


TOPHATTEREXPRESS
Tophatter Express.


MGLOBAL
PT MGLOBAL LOGISTICS INDONESIA.


AVERITT
Averitt Express.


LEADER
leader.


_2EBOX
2ebox courier.


SG_SPEEDPOST
Singapore Speedpost.


DBSCHENKER_SE
DB Schenker (www.dbschenker.com).


ISR_POST_DOMESTIC
Israel Post Domestic.


BESTWAYPARCEL
Best Way Parcel.


ASENDIA_DE
asendia_de.


NIGHTLINE_UK
nightline_uk.


TAQBIN_SG
taqbin_sg.


TCK_EXPRESS
TCK Express.


ENDEAVOUR_DELIVERY
Endeavour Delivery.


NANJINGWOYUAN
Nanjing Woyuan.


HEPPNER_FR
Heppner France.


EMPS_CN
EMPS Express.


FONSEN
Fonsen Logistics.


PICKRR
Pickrr.


APC_OVERNIGHT_CONNUM
APC Overnight Consignment.


STAR_TRACK_NEXT_FLIGHT
Star Track Next Flight.


DAJIN
Shanghai Aqrum Chemical Logistics Co.Ltd.


UPS_FREIGHT
UPS Freight.


POSTA_PLUS
Posta Plus.


CEVA
CEVA LOGISTICS.


ANSERX
ANSERX courier.


JS_EXPRESS
JS EXPRESS.


PADTF
padtf.com.


UPS_MAIL_INNOVATIONS
UPS Mail Innovations.


SYPOST
Sunyou Post.


AMAZON_SHIP_MCF
Amazon Shipping + Amazon MCF.


YUSEN
Yusen Logistics.


BRING
Bring.


SDA_IT
SDA Italy.


GBA
GBA Services Ltd.


NEWEGGEXPRESS
Newegg Express.


SPEEDCOURIERS_GR
Speed Couriers.


FORRUN
forrun Pvt Ltd (Arpatech Venture).


PICKUP
Pickupp.


ECMS
ECMS International Logistics Co..


INTELIPOST
Intelipost (TMS for LATAM).


FLASHEXPRESS
Flash Express.


CN_STO
STO Express.


SEKO_SFTP
SEKO Worldwide.


HOME_DELIVERY_SOLUTIONS
Home Delivery Solutions Ltd.


DPD_HGRY
DPD Hungary.


KERRYTTC_VN
Kerry Express (Vietnam) Co Ltd.


JOYING_BOX
Joying Box.


TOTAL_EXPRESS
Total Express.


ZJS_EXPRESS
ZJS International.


STARKEN
STARKEN couriers.


DEMANDSHIP
DemandShip.


CN_DPEX
DPEX.


AUPOST_CN
AuPost China.


LOGISTERS
Logisters.


GOGLOBALPOST
Global Post.


GLS_CZ
GLS Czech Republic.


PAACK_WEBHOOK
Paack courier.


GRAB_WEBHOOK
Grab courier.


PARCELPOINT
Parcelpoint.


ICUMULUS
iCumulus.


DAIGLOBALTRACK
DAI Post.


GLOBAL_IPARCEL
i-parcel.


YURTICI_KARGO
Yurtici Kargo.


CN_PAYPAL_PACKAGE
PayPal Package.


PARCEL_2_POST
Parcel To Post.


GLS_IT
GLS Italy.


PIL_LOGISTICS
PIL Logistics (China) Co..


HEPPNER
Heppner Internationale Spedition GmbH & Co..


GENERAL_OVERNIGHT
Go!Express and logistics.


HAPPY2POINT
Happy 2ThePoint.


CHITCHATS
Chit Chats.


SMOOTH
Smooth Couriers.


CLE_LOGISTICS
CL E-Logistics Solutions Limited.


FIEGE
Fiege Logistics.


MX_CARGO
M&X cargo.


ZIINGFINALMILE
Ziing Final Mile Inc.


DAYTON_FREIGHT
Dayton Freight.


TCS
TCS courier.


AEX
AEX Group.


HERMES_DE
Hermes Germany.


ROUTIFIC_WEBHOOK
Routific.


GLOBAVEND
Globavend.


CJ_LOGISTICS
CJ Logistics International.


PALLET_NETWORK
The Pallet Network.


RAF_PH
RAF Philippines.


UK_XDP
XDP Express.


PAPER_EXPRESS
Paper Express.


LA_POSTE_SUIVI
La Poste.


PAQUETEXPRESS
Paquetexpress.


LIEFERY
liefery.


STRECK_TRANSPORT
Streck Transport.


PONY_EXPRESS
Pony express.


ALWAYS_EXPRESS
Always Express.


GBS_BROKER
GBS-Broker.


CITYLINK_MY
City-Link Express.


ALLJOY
ALLJOY SUPPLY CHAIN.


YODEL
yodel.


YODEL_DIR
Yodel Direct.


STONE3PL
STONE3PL.


PARCELPAL_WEBHOOK
ParcelPal.


DHL_ECOMERCE_ASA
DHL eCommerce Asia (API).


SIMPLYPOST
J&T Express Singapore.


KY_EXPRESS
Kua Yue Express.


SHENZHEN
shenzhen 1st International Logistics(Group)Co.


US_LASERSHIP
LaserShip.


UC_EXPRE
ucexpress.


DIDADI
DIDADI Logistics tech.


CJ_KR
CJ Korea Express.


DBSCHENKER_B2B
DB Schenker B2B.


MXE
MXE Express.


CAE_DELIVERS
CAE Delivers.


PFCEXPRESS
PFC Express.


WHISTL
Whistl.


WEPOST
WePost Sdn Bhd.


DHL_PARCEL_ES
DHL parcel Spain(www.dhl.com).


DDEXPRESS
DD Express Courier.


ARAMEX_AU
Aramex Australia (formerly Fastway AU).


BNEED
Bneed courier.


HK_TGX
Kerry Express Hong Kong.


LATVIJAS_PASTS
Latvijas Pasts.


VIAEUROPE
ViaEurope.


CORREO_UY
Correo Uruguayo.


CHRONOPOST_FR
Chronopost france (www.chronopost.fr).


J_NET
J-Net.


_6LS
6ls.com.


BLR_BELPOST
Belpost.


BIRDSYSTEM
BirdSystem.


DOBROPOST
DobroPost.


WAHANA_ID
Wahana express (www.wahana.com).


WEASHIP
Weaship.


SONICTL
Sonic Transportation & Logistics.


KWT
Shenzhen Jinghuada Logistics Co..


AFLLOG_FTP
AFL LOGISTICS.


SKYNET_WORLDWIDE
SkyNet Worldwide Express.


NOVA_POSHTA
Nova Poshta (novaposhta.ua).


SEINO
Seino.


SZENDEX
SZENDEX.


BPOST_INT
Bpost international.


DBSCHENKER_SV
DB Schenker Sweden.


AO_DEUTSCHLAND
AO Deutschland.


EU_FLEET_SOLUTIONS
EU Fleet Solutions.


PCFCORP
PCF Final Mile.


LINKBRIDGE
Link Bridge(BeiJing)international logistics co..


PRIMAMULTICIPTA
PT Prima Multi Cipta.


COUREX
Urbanfox.


ZAJIL_EXPRESS
Zajil Express Company.


COLLECTCO
CollectCo.


JTEXPRESS
J&T EXPRESS MALAYSIA.


FEDEX_UK
FedEx® UK.


USHIP
uShip courier.


PIXSELL
PIXSELL LOGISTICS.


SHIPTOR
Shiptor.


CDEK
CDEK courier.


VNM_VIETTELPOST
ViettelPost.


CJ_CENTURY
CJ Century.


GSO
GSO(GLS-USA).


VIWO
VIWO IoT.


SKYBOX
SKYBOX.


KERRYTJ
Kerry TJ Logistics.


NTLOGISTICS_VN
Nhat Tin Logistics.


SDH_SCM
lightning monkey.


ZINC
Zinc courier.


DPE_SOUTH_AFRC
DPE South Africa.


CESKA_CZ
Czech Post.


ACS_GR
ACS Courier.


DEALERSEND
DealerSend.


JOCOM
Jocom.


CSE
CSE courier.


TFORCE_FINALMILE
TForce Final Mile.


SHIP_GATE
ShipGate.


SHIPTER
SHIPTER.


NATIONAL_SAMEDAY
National Sameday.


YUNEXPRESS
YunExpress.


CAINIAO
AliExpress Standard Shipping.


DMS_MATRIX
DMSMatrix.


DIRECTLOG
Directlog (www.directlog.com.br).


ASENDIA_US
Asendia USA.


_3JMSLOGISTICS
3JMS Logistics.


LICCARDI_EXPRESS
LICCARDI EXPRESS COURIER.


SKY_POSTAL
SkyPostal.


CNWANGTONG
cnwangtong.


POSTNORD_LOGISTICS_DK
ostnord denmark.


LOGISTIKA
Logistika.


CELERITAS
Celeritas Transporte.


PRESSIODE
Pressio.


SHREE_MARUTI
Shree Maruti Courier Services Pvt Ltd.


LOGISTICSWORLDWIDE_HK
Logistic Worldwide Express (LWE Honkong).


EFEX
eFEx (E-Commerce Fulfillment & Express).


LOTTE
Lotte Global Logistics.


LONESTAR
Lone Star Overnight.


APRISAEXPRESS
Aprisa Express.


BEL_RS
BEL North Russia.


OSM_WORLDWIDE
OSM Worldwide.


WESTGATE_GL
Westgate Global.


FASTRACK
Fasttrack.


DTD_EXPR
DTD Express.


ALFATREX
AlfaTrex.


PROMEDDELIVERY
ProMed Delivery.


THABIT_LOGISTICS
Thabit Logistics.


HCT_LOGISTICS
HCT LOGISTICS CO.LTD..


CARRY_FLAP
Carry-Flap Co..


US_OLD_DOMINION
Old Dominion Freight Line.


ANICAM_BOX
ANICAM BOX EXPRESS.


WANBEXPRESS
WanbExpress.


AN_POST
An Post.


DPD_LOCAL
DPD Local.


STALLIONEXPRESS
Stallion Express.


RAIDEREX
RaidereX.


SHOPFANS
ShopfansRU LLC.


KYUNGDONG_PARCEL
Kyungdong Parcel.


CHAMPION_LOGISTICS
Champion Logistics.


PICKUPP_SGP
PICK UPP (Singapore).


MORNING_EXPRESS
Morning Express.


NACEX
NACEX.


THENILE_WEBHOOK
SortHub courier.


HOLISOL
Holisol.


LBCEXPRESS_FTP
LBC EXPRESS INC..


KURASI
KURASI.


USF_REDDAWAY
USF Reddaway.


APG
APG eCommerce Solutions.


CN_BOXC
BoxC courier.


ECOSCOOTING
ECOSCOOTING.


MAINWAY
Mainway.


PAPERFLY
Paperfly Private Limited.


HOUNDEXPRESS
Hound Express.


BOX_BERRY
Boxberry courier.


EP_BOX
EP-Box courier.


PLUS_LOG_UK
Plus UK Logistics.


FULFILLA
Fulfilla.


ASE
ASE KARGO.


MAIL_PLUS
MailPlus.


XPO_LOGISTICS
XPO logistics.


WNDIRECT
wnDirect.


CLOUDWISH_ASIA
Cloudwish Asia.


ZELERIS
Zeleris.


GIO_EXPRESS
Gio Express.


OCS_WORLDWIDE
OCS WORLDWIDE.


ARK_LOGISTICS
ARK Logistics.


AQUILINE
Aquiline.


PILOT_FREIGHT
Pilot Freight Services.


QWINTRY
Qwintry Logistics.


DANSKE_FRAGT
Danske Fragtaend.


CARRIERS
Carriers courier.


AIR_CANADA_GLOBAL
Rivo (Air canada).


PRESIDENT_TRANS
PRESIDENT TRANSNET CORP.


STEPFORWARDFS
STEP FORWARD FREIGHT SERVICE CO LTD.


SKYNET_UK
Skynet UK.


PITTOHIO
PITT OHIO.


CORREOS_EXPRESS
Correos Express.


RL_US
RL Carriers.


DESTINY
Destiny Transportation.


UK_YODEL
Yodel (www.yodel.co.uk).


COMET_TECH
CometTech.


DHL_PARCEL_RU
DHL Parcel Russia.


TNT_REFR
TNT Reference.


SHREE_ANJANI_COURIER
Shree Anjani Courier.


MIKROPAKKET_BE
Mikropakket Belgium.


ETS_EXPRESS
RETS express.


COLIS_PRIVE
Colis Privé.


CN_YUNDA
Yunda Express.


AAA_COOPER
AAA Cooper.


ROCKET_PARCEL
Rocket Parcel International.


_360LION
360 Lion Express.


PANDU
PANDU.


PROFESSIONAL_COURIERS
PROFESSIONAL COURIERS.


FLYTEXPRESS
FLYTEXPRESS.


LOGISTICSWORLDWIDE_MY
LOGISTICSWORLDWIDE MY.


CORREOS_DE_ESPANA
CORREOS DE ESPANA.


IMX
IMX.


FOUR_PX_EXPRESS
FOUR PX EXPRESS.


XPRESSBEES
XPRESSBEES.


PICKUPP_VNM
pickupp_vnm.


STARTRACK_EXPRESS
startrack_express.


FR_COLISSIMO
fr_colissimo.


NACEX_SPAIN_REFERENCE
nacex_spain_reference.


DHL_SUPPLY_CHAIN_AU
dhl_supply_chain_au.


ESHIPPING
Eshipping.


SHREETIRUPATI
SHREE TIRUPATI COURIER SERVICES PVT. LTD..


HX_EXPRESS
HX Express.


INDOPAKET
INDOPAKET.


CN_17POST
17 Post Service.


K1_EXPRESS
K1 Express.


CJ_GLS
CJ GLS.


MYS_GDEX
GDEX courier.


NATIONEX
Nationex courier.


ANJUN
Anjun couriers.


FARGOOD
FarGood.


SMG_EXPRESS
SMG Direct.


RZYEXPRESS
RZY Express.


SEFL
Southeastern Freight Lines.


TNT_CLICK_IT
TNT-Click Italy.


HDB
Haidaibao.


HIPSHIPPER
Hipshipper.


RPXLOGISTICS
RPX Logistics.


KUEHNE
Kuehne + Nagel.


IT_NEXIVE
Nexive (TNT Post Italy).


PTS
PTS courier.


SWISS_POST_FTP
Swiss Post FTP.


FASTRK_SERV
Fastrak Services.


_4_72
4-72 Entregando.


US_YRC
YRC courier.


POSTNL_INTL_3S
PostNL International 3S.


ELIAN_POST
Yilian (Elian) Supply Chain.


CUBYN
Cubyn.


SAU_SAUDI_POST
Saudi Post.


ABXEXPRESS_MY
ABX Express.


HUAHAN_EXPRESS
HUAHANG EXPRESS.


ZES_EXPRESS
Eshun international Logistic.


ZEPTO_EXPRESS
ZeptoExpress.


SKYNET_ZA
Skynet World Wide Express South Africa.


ZEEK_2_DOOR
Zeek2Door.


BLINKLASTMILE
Blink.


POSTA_UKR
UkrPoshta.


CHROBINSON
C.H. Robinson Worldwide.


CN_POST56
Post56.


COURANT_PLUS
Courant Plus.


SCUDEX_EXPRESS
Scudex Express.


SHIPENTEGRA
ShipEntegra.


B_TWO_C_EUROPE
B2C courier Europe.


COPE
Cope Sensitive Freight.


IND_GATI
Gati-KWE.


CN_WISHPOST
WishPost.


NACEX_ES
NACEX Spain.


TAQBIN_HK
TAQBIN Hong Kong.


GLOBALTRANZ
GlobalTranz.


HKD
Qingdao HKD International Logistics.


BJSHOMEDELIVERY
BJS Distribution courier.


OMNIVA
Omniva.


SUTTON
Sutton Transport.


PANTHER_REFERENCE
Panther Reference.


SFCSERVICE
SFC Service.


LTL
LTL COURIER.


PARKNPARCEL
Park N Parcel.


SPRING_GDS
Spring GDS.


ECEXPRESS
ECexpress.


INTERPARCEL_AU
Interparcel Australia.


AGILITY
Agility.


XL_EXPRESS
XL Express.


ADERONLINE
Ader couriers.


DIRECTCOURIERS
Direct Couriers.


PLANZER
Planzer Group.


SENDING
Sending Transporte Urgente y Comunicacion.


NINJAVAN_WB
Ninjavan Webhook.


NATIONWIDE_MY
Nationwide Express Courier Services Bhd (www.nationwide.com.my).


SENDIT
Sendit.


GB_ARROW
Arrow XL.


IND_GOJAVAS
GoJavas.


KPOST
Korea Post.


DHL_FREIGHT
DHL Freight.


BLUECARE
Bluecare Express Ltd.


JINDOUYUN
jindouyun courier.


TRACKON
Trackon Couriers Pvt. Ltd.


GB_TUFFNELLS
Tuffnells Parcels Express.


TRUMPCARD
TRUMPCARD LLC.


ETOTAL
eTotal Solution Limited.


SFPLUS_WEBHOOK
Zeek courier.


SEKOLOGISTICS
SEKO Logistics.


HERMES_2MANN_HANDLING
Hermes Einrichtungs Service GmbH & Co. KG.


DPD_LOCAL_REF
DPD Local reference.


UDS
United Delivery Service.


ZA_SPECIALISED_FREIGHT
Specialised Freight.


THA_KERRY
Kerry Express Thailand.


PRT_INT_SEUR
SEUR International.


BRA_CORREIOS
Correios Brazil.


NZ_NZ_POST
New Zealand Post.


CN_EQUICK
Equick China.


MYS_EMS
Malaysia Post EMS / Pos Laju.


GB_NORSK
Norsk Global.


ESP_MRW
MRW spain.


ESP_PACKLINK
Packlink.


KANGAROO_MY
Kangaroo Worldwide Express.


RPX
RPX Online.


XDP_UK_REFERENCE
XDP Express Reference.


NINJAVAN_MY
ninja van (www.ninjavan.co).


ADICIONAL
Adicional Logistics.


ROADBULL
Red Carpet Logistics.


YAKIT
Yakit courier.


MAILAMERICAS
MailAmericas.


MIKROPAKKET
Mikropakket.


DYNALOGIC
Dynamic Logistics.


DHL_ES
DHL Spain(www.dhl.com).


DHL_PARCEL_NL
DHL Parcel NL.


DHL_GLOBAL_MAIL_ASIA
DHL Global Mail Asia (www.dhl.com).


DAWN_WING
Dawn Wing.


GENIKI_GR
Geniki Taxydromiki.


HERMESWORLD_UK
hermesworld_uk.


ALPHAFAST
Alphafast (www.alphafast.com).


BUYLOGIC
buylogic.


EKART
Ekart logistics (ekartlogistics.com).


MEX_SENDA
mexico senda express.


SFC_LOGISTICS
SFC.


POST_SERBIA
Posta Serbia.


IND_DELHIVERY
Delhivery India.


DE_DPD_DELISTRACK
DPD Germany.


RPD2MAN
RPD2man Deliveries.


CN_SF_EXPRESS
SF Express (www.sf-express.com).


YANWEN
Yanwen Logistics.


MYS_SKYNET
Skynet Malaysia.


CORREOS_DE_MEXICO
correos mexico.


CBL_LOGISTICA
CBL Logistica.


MEX_ESTAFETA
Estafeta (www.estafeta.com).


AU_AUSTRIAN_POST
Austrian Post (Registered).


RINCOS
Rincos.


NLD_DHL
DHL Netherland.


RUSSIAN_POST
Russian post.


COURIERS_PLEASE
CouriersPlease (couriersplease.com.au).


POSTNORD_LOGISTICS
PostNord Logistics.


FEDEX
Fedex.


DPE_EXPRESS
DPE Express.


DPD
DPD.


ADSONE
ADSone.


IDN_JNE
JNE Express (Jalur Nugraha Ekakurir).


THECOURIERGUY
The Courier Guy.


CNEXPS
CNE Express.


PRT_CHRONOPOST
Chronopost Portugal.


LANDMARK_GLOBAL
Landmark Global.


IT_DHL_ECOMMERCE
DHL International.


ESP_NACEX
NACEX Spain.


PRT_CTT
CTT Portugal.


BE_KIALA
Kiala.


ASENDIA_UK
Asendia UK.


GLOBAL_TNT
TNT global.


POSTUR_IS
Iceland Post.


EPARCEL_KR
eParcel Korea.


INPOST_PACZKOMATY
InPost Paczkomaty.


IT_POSTE_ITALIA
Poste italiane (www.poste.it).


BE_BPOST
Bpost (www.bpost.be).


PL_POCZTA_POLSKA
Poczta Polska (www.poczta-polska.pl).


MYS_MYS_POST
Malaysia Post.


SG_SG_POST
Singapore Post.


THA_THAILAND_POST
Thailand Post (www.thailandpost.co.th).


LEXSHIP
LexShip.


FASTWAY_NZ
Fastway New Zealand.


DHL_AU
DHL Supply Chain Australia.


COSTMETICSNOW
Cosmetics Now.


PFLOGISTICS
PFL.


LOOMIS_EXPRESS
Loomis Express.


GLS_ITALY
GLS Italy.


LINE
Line Clear Express & Logistics Sdn Bhd.


GEL_EXPRESS
Gel Express Logistik.


HUODULL
Huodull.


NINJAVAN_SG
Ninja van Singapore.


JANIO
Janio Asia.


AO_COURIER
AO Logistics.


BRT_IT_SENDER_REF
BRT Bartolini(Sender Reference).


SAILPOST
SAILPOST.


LALAMOVE
Lalamove.


NEWZEALAND_COURIERS
NEW ZEALAND COURIERS.


ETOMARS
Etomars.


VIRTRANSPORT
VIR Transport.


WIZMO
Wizmo.


PALLETWAYS
Palletways.


I_DIKA
i-dika.


CFL_LOGISTICS
CFL Logistics.


GEMWORLDWIDE
GEM Worldwide.


GLOBAL_EXPRESS
Tai Wan Global Business.


LOGISTYX_TRANSGROUP
Transgroup courier.


WESTBANK_COURIER
West Bank Courier.


ARCO_SPEDIZIONI
Arco Spedizioni SP.


YDH_EXPRESS
YDH express.


PARCELINKLOGISTICS
Parcelink Logistics.


CNDEXPRESS
CND Express.


NOX_NIGHT_TIME_EXPRESS
NOX NightTimeExpress.


AERONET
Aeronet couriers.


LTIANEXP
LTIAN EXP.


INTEGRA2_FTP
Integra2.


PARCELONE
PARCEL ONE.


NOX_NACHTEXPRESS
Innight Express Germany GmbH (nox NachtExpress).


CN_CHINA_POST_EMS
China Post.


CHUKOU1
Chukou1.


GLS_SLOV
GLS General Logistics Systems Slovakia s.r.o..


ORANGE_DS
OrangeDS (Orange Distribution Solutions Inc).


JOOM_LOGIS
Joom Logistics.


AUS_STARTRACK
StarTrack (startrack.com.au).


DHL
dhl Global.


GB_APC
APC postal logistics germany.


BONDSCOURIERS
Bonds Courier Service (bondscouriers.com.au).


JPN_JAPAN_POST
Japan Post.


USPS
United States Postal Service.


WINIT
WinIt.


ARG_OCA
OCA Argentina.


TW_TAIWAN_POST
Taiwan Post.


DMM_NETWORK
DMM Network.


TNT
TNT Express.


BH_POSTA
BH Posta (www.posta.ba).


SWE_POSTNORD
Postnord sweden.


CA_CANADA_POST
Canada Post.


WISELOADS
Wiseloads.


ASENDIA_HK
Asendia HonKong.


NLD_GLS
GLS Netherland.


MEX_REDPACK
Redpack.


JET_SHIP
Jet-Ship Worldwide.


DE_DHL_EXPRESS
DHL Express.


NINJAVAN_THAI
Ninja van Thai.


RABEN_GROUP
Raben Group.


ESP_ASM
ASM(GLS Spain).


HRV_HRVATSKA
Hrvatska posta.


GLOBAL_ESTES
Estes Express Lines.


LTU_LIETUVOS
Lietuvos pastas.


BEL_DHL
DHL Benelux.


AU_AU_POST
Australia Post.


SPEEDEXCOURIER
SPEEDEX couriers.


FR_COLIS
Colissimo.


ARAMEX
Aramex.


DPEX
DPEX (www.dpex.com).


MYS_AIRPAK
Airpak Express.


CUCKOOEXPRESS
Cuckoo Express.


DPD_POLAND
DPD Poland.


NLD_POSTNL
PostNL International.


NIM_EXPRESS
Nim Express.


QUANTIUM
Quantium.


SENDLE
Sendle.


ESP_REDUR
Redur Spain.


MATKAHUOLTO
Matkahuolto.


CPACKET
Cpacket couriers.


POSTI
Posti courier.


HUNTER_EXPRESS
Hunter Express.


CHOIR_EXP
Choir Express Indonesia.


LEGION_EXPRESS
Legion Express.


AUSTRIAN_POST_EXPRESS
austrian post.


GRUPO
Grupo ampm.


POSTA_RO
Post Roman (www.posta-romana.ro).


INTERPARCEL_UK
Interparcel UK.


GLOBAL_ABF
ABF Freight.


POSTEN_NORGE
Posten Norge (www.posten.no).


XPERT_DELIVERY
Xpert Delivery.


DHL_REFR
DHl (Reference number).


DHL_HK
DHL HonKong.


SKYNET_UAE
SKYNET UAE.


GOJEK
Gojek.


YODEL_INTNL
Yodel International.


JANCO
Janco Ecommerce.


YTO
YTO Express.


WISE_EXPRESS
Wise Express.


JTEXPRESS_VN
J&T Express Vietnam.


FEDEX_INTL_MLSERV
FedEx International MailService.


VAMOX
VAMOX.


AMS_GRP
AMS Group.


DHL_JP
DHL Japan.


HRPARCEL
HR Parcel.


GESWL
GESWL Express.


BLUESTAR
Blue Star.


CDEK_TR
CDEK TR.


DESCARTES
Innovel courier.


DELTEC_UK
Deltec Courier.


DTDC_EXPRESS
DTDC express.


TOURLINE
tourline.


BH_WORLDWIDE
B&H Worldwide.


OCS
OCS ANA Group.


YINGNUO_LOGISTICS
yingnuo logistics.


UPS
United Parcel Service.


TOLL
Toll IPEC.


PRT_SEUR
SEUR portugal.


DTDC_AU
DTDC Australia.


THA_DYNAMIC_LOGISTICS
Dynamic Logistics.


UBI_LOGISTICS
UBI Smart Parcel.


FEDEX_CROSSBORDER
FedEx Cross Border.


A1POST
A1Post.


TAZMANIAN_FREIGHT
Tazmanian Freight Systems.


CJ_INT_MY
CJ International malaysia.


SAIA_FREIGHT
Saia LTL Freight.


SG_QXPRESS
Qxpress.


NHANS_SOLUTIONS
Nhans Solutions.


DPD_FR
DPD France.


COORDINADORA
Coordinadora.


ANDREANI
Grupo logistico Andreani.


DOORA
Doora Logistics.


INTERPARCEL_NZ
Interparcel New Zealand.


PHL_JAMEXPRESS
Jam Express Philippines.


BEL_BELGIUM_POST
bel_belgium_post.


US_APC
us_apc.


IDN_POS
idn_pos.


FR_MONDIAL
fr_mondial.


DE_DHL
DE DHL.


HK_RPX
hk_rpx.


DHL_PIECEID
dhl_pieceid.


VNPOST_EMS
vnpost_ems.


RRDONNELLEY
rrdonnelley.


DPD_DE
dpd_de.


DELCART_IN
delcart_in.


IMEXGLOBALSOLUTIONS
imexglobalsolutions.


ACOMMERCE
ACOMMERCE.


EURODIS
eurodis.


CANPAR
CANPAR.


GLS
GLS.


IND_ECOM
Ecom Express.


ESP_ENVIALIA
Envialia.


DHL_UK
dhl UK.


SMSA_EXPRESS
SMSA Express.


TNT_FR
TNT France.


DEX_I
DEX-I courier.


BUDBEE_WEBHOOK
Budbee courier.


COPA_COURIER
Copa Airlines Courier.


VNM_VIETNAM_POST
Vietnam Post.


DPD_HK
DPD HongKong.


TOLL_NZ
Toll New Zealand.


ECHO
Echo courier.


FEDEX_FR
FedEx® Freight.


BORDEREXPRESS
Border Express.


MAILPLUS_JPN
MailPlus (Japan).


TNT_UK_REFR
TNT UK Reference.


KEC
KEC courier.


DPD_RO
DPD Romania.


TNT_JP
TNT_JP.


TH_CJ
TH_CJ.


EC_CN
EC_CN.


FASTWAY_UK
FASTWAY_UK.


FASTWAY_US
FASTWAY_US.


GLS_DE
GLS_DE.


GLS_ES
GLS_ES.


GLS_FR
GLS_FR.


MONDIAL_BE
MONDIAL_BE.


SGT_IT
SGT_IT.


TNT_CN
TNT_CN.


TNT_DE
TNT_DE.


TNT_ES
TNT_ES.


TNT_PL
TNT_PL.


PARCELFORCE
PARCELFORCE.


SWISS_POST
SWISS POST.


TOLL_IPEC
TOLL IPEC.


AIR_21
AIR 21.


AIRSPEED
AIRSPEED.


BERT
BERT.


BLUEDART
BLUEDART.


COLLECTPLUS
COLLECTPLUS.


COURIERPLUS
COURIERPLUS.


COURIER_POST
COURIER POST.


DHL_GLOBAL_MAIL
dhl_global_mail.


DPD_UK
dpd_uk.


DELTEC_DE
DELTEC DE.


DEUTSCHE_DE
deutsche_de.


DOTZOT
DOTZOT.


ELTA_GR
elta_gr.


EMS_CN
ems_cn.


ECARGO
ECARGO.


ENSENDA
ENSENDA.


FERCAM_IT
fercam_it.


FASTWAY_ZA
fastway_za.


FASTWAY_AU
fastway_au.


FIRST_LOGISITCS
first_logisitcs.


GEODIS
GEODIS.


GLOBEGISTICS
GLOBEGISTICS.


GREYHOUND
GREYHOUND.


JETSHIP_MY
jetship_my.


LION_PARCEL
LION PARCEL.


AEROFLASH
AEROFLASH.


ONTRAC
ONTRAC.


SAGAWA
SAGAWA.


SIODEMKA
SIODEMKA.


STARTRACK
startrack.


TNT_AU
tnt_au.


TNT_IT
tnt_it.


TRANSMISSION
TRANSMISSION.


YAMATO
YAMATO.


DHL_IT
dhl_it.


DHL_AT
dhl_at.


LOGISTICSWORLDWIDE_KR
LOGISTICSWORLDWIDE KR.


GLS_SPAIN
gls_spain.


AMAZON_UK_API
amazon_uk_api.


DPD_FR_REFERENCE
dpd_fr_reference.


DHLPARCEL_UK
dhlparcel_uk.


MEGASAVE
megasave.


QUALITYPOST
qualitypost.


IDS_LOGISTICS
ids_logistics.


JOYINGBOX
joyingbox.


PANTHER_ORDER_NUMBER
panther_order_number.


WATKINS_SHEPARD
watkins_shepard.


FASTTRACK
fasttrack.


UP_EXPRESS
up_express.


ELOGISTICA
elogistica.


ECOURIER
ecourier.


CJ_PHILIPPINES
cj_philippines.


SPEEDEX
speedex.


ORANGECONNEX
orangeconnex.


TECOR
tecor.


SAEE
saee.


GLS_ITALY_FTP
gls_italy_ftp.


DELIVERE
delivere.


YYCOM
yycom.


ADICIONAL_PT
Adicional Logistics.


DKSH
DKSH.


NIPPON_EXPRESS_FTP
Nippon Express.


GOLS
GO Logistics & Storage.


FUJEXP
FUJIE EXPRESS.


QTRACK
QTrack.


OMLOGISTICS_API
OM LOGISTICS LTD.


GDPHARM
GDPharm Logistics.


MISUMI_CN
MISUMI Group Inc..


AIR_CANADA
Rivo.


CITY56_WEBHOOK
City Express.


SAGAWA_API
Sagawa.


KEDAEX
KedaEX.


PGEON_API
Pgeon.


WEWORLDEXPRESS
We World Express.


JT_LOGISTICS
J&T International logistics.


TRUSK
Trusk France.


VIAXPRESS
ViaXpress.


DHL_SUPPLYCHAIN_ID
DHL Supply Chain Indonesia.


ZUELLIGPHARMA_SFTP
Zuellig Pharma Korea.


MEEST
Meest.


TOLL_PRIORITY
Toll Priority.


MOTHERSHIP_API
Mothership.


CAPITAL
Capital Transport.


EUROPAKET_API
Europacket+.


HFD
HFD.


TOURLINE_REFERENCE
Tourline Express.


GIO_ECOURIER
GIO Express Inc.


CN_LOGISTICS
CN Logistics.


PANDION
Pandion.


BPOST_API
Bpost API.


PASSPORTSHIPPING
Passport Shipping.


PAKAJO
Pakajo World.


DACHSER
DACHSER.


YUSEN_SFTP
Yusen Logistics.


SHYPLITE
Shypmax.


XYY
Xingyunyi Logistics.


MWD
Metropolitan Warehouse & Delivery.


FAXECARGO
Faxe Cargo.


MAZET
Groupe Mazet.


FIRST_LOGISTICS_API
First Logistics.


SPRINT_PACK
SPRINT PACK.


HERMES_DE_FTP
Hermes Germany.


CONCISE
Concise.


KERRY_EXPRESS_TW_API
Kerry Express TaiWan.


EWE
EWE Global Express.


FASTDESPATCH
Fast Despatch Logistics Limited.


ABCUSTOM_SFTP
AB Custom Group.


CHAZKI
Chazki.


SHIPPIE
Shippie.


GEODIS_API
GEODIS - Distribution & Express.


NAQEL_EXPRESS
Naqel Express.


PAPA_WEBHOOK
Papa.


FORWARDAIR
Forward Air.


DIALOGO_LOGISTICA_API
Dialogo Logistica.


LALAMOVE_API
Lalamove.


TOMYDOOR
Tomydoor.


KRONOS_WEBHOOK
Kronos Express.


JTCARGO
J&T CARGO.


T_CAT
T-cat.


CONCISE_WEBHOOK
Concise.


TELEPORT_WEBHOOK
Teleport.


CUSTOMCO_API
The Custom Companies.


SPX_TH
Shopee Xpress.


BOLLORE_LOGISTICS
Bollore Logistics.


CLICKLINK_SFTP
ClickLink.


M3LOGISTICS
M3 Logistics.


VNPOST_API
Vietnam Post.


AXLEHIRE_FTP
Axlehire.


SHADOWFAX
Shadowfax.


MYHERMES_UK_API
EVRi.


DAIICHI
Daiichi Freight System Inc.


MENSAJEROSURBANOS_API
Mensajeros Urbanos.


POLARSPEED
PolarSpeed Inc.


IDEXPRESS_ID
iDexpress Indonesia.


PAYO
Payo.


WHISTL_SFTP
Whistl.


INTEX_DE
INTEX Paketdienst GmbH.


TRANS2U
Trans2u.


PRODUCTCAREGROUP_SFTP
Product Care Services Limited.


BIGSMART
Big Smart.


EXPEDITORS_API_REF
Expeditors API Reference.


AITWORLDWIDE_API
AIT.


WORLDCOURIER
World Courier.


QUIQUP
Quiqup.


AGEDISS_SFTP
Agediss.


ANDREANI_API
Andreani.


CRLEXPRESS
CRL Express.


SMARTCAT
SMARTCAT.


CROSSFLIGHT
Crossflight Limited.


PROCARRIER
Pro Carrier.


DHL_REFERENCE_API
DHL (Reference number).


SEINO_API
Seino.


WSPEXPRESS
WSP Express.


KRONOS
Kronos Express.


TOTAL_EXPRESS_API
Total Express.


PARCLL
PARCLL.


XPEDIGO
Xpedigo.


STAR_TRACK_WEBHOOK
StarTrack.


GPOST
Georgian Post.


UCS
UCS.


DMFGROUP
DMF.


COORDINADORA_API
Coordinadora.


MARKEN
Marken.


NTL
NTL logistics.


REDJEPAKKETJE
Red je Pakketje.


ALLIED_EXPRESS_FTP
Allied Express (FTP).


MONDIALRELAY_ES
Mondial Relay Spain(Punto Pack).


NAEKO_FTP
Naeko Logistics.


MHI
Mhi.


SHIPPIFY
Shippify, Inc.


MALCA_AMIT_API
Malca Amit.


JTEXPRESS_SG_API
J&T Express Singapore.


DACHSER_WEB
DACHSER.


FLIGHTLG
Flight Logistics Group.


CAGO
Cago.


COM1EXPRESS
ComOne Express.


TONAMI_FTP
Tonami.


PACKFLEET
PACKFLEET.


PUROLATOR_INTERNATIONAL
Purolator International.


WINESHIPPING_WEBHOOK
Wineshipping.


DHL_ES_SFTP
DHL Spain Domestic.


PCHOME_API
網家速配股份有限公司.


CESKAPOSTA_API
Czech Post.


GORUSH
Go Rush.


HOMERUNNER
HomeRunner.


AMAZON_ORDER
Amazon order.


EFWNOW_API
Estes Forwarding Worldwide.


CBL_LOGISTICA_API
CBL Logistica (API).


NIMBUSPOST
NimbusPost.


LOGWIN_LOGISTICS
Logwin Logistics.


NOWLOG_API
Sequoialog.


DPD_NL
DPD Netherlands.


GODEPENDABLE
Dependable Supply Chain Services.


ESDEX
Top Ideal Express.


LOGISYSTEMS_SFTP
Kiitäjät.


EXPEDITORS
Expeditors.


SNTGLOBAL_API
Snt Global Etrax.


SHIPX
ShipX.


QINTL_API
Quickstat Courier LLC.


PACKS
Packs.


POSTNL_INTERNATIONAL
PostNL International.


AMAZON_EMAIL_PUSH
Amazon.


DHL_API
DHL.


SPX
Shopee Express.


AXLEHIRE
AxleHire.


ICSCOURIER
ICS COURIER.


DIALOGO_LOGISTICA
Dialogo Logistica.


SHUNBANG_EXPRESS
ShunBang Express.


TCS_API
TCS.


SF_EXPRESS_CN
SF Express China.


PACKETA
Packeta.


SIC_TELIWAY
Teliway SIC Express.


MONDIALRELAY_FR
Mondial Relay France.


INTIME_FTP
InTime.


JD_EXPRESS
京东物流.


FASTBOX
Fastbox.


PATHEON
Patheon Logistics.


INDIA_POST
India Post Domestic.


TIPSA_REF
Tipsa Reference.


ECOFREIGHT
Eco Freight.


VOX
VOX SOLUCION EMPRESARIAL SRL.


DIRECTFREIGHT_AU_REF
Direct Freight Express.


BESTTRANSPORT_SFTP
Best Transport.


AUSTRALIA_POST_API
Australia Post.


FRAGILEPAK_SFTP
FragilePAK.


FLIPXP
FlipXpress.


VALUE_WEBHOOK
Value Logistics.


DAESHIN
Daeshin.


SHERPA
Sherpa.


MWD_API
Metropolitan Warehouse & Delivery.


SMARTKARGO
SmartKargo.


DNJ_EXPRESS
DNJ Express.


GOPEOPLE
Go People.


MYSENDLE_API
mySendle.


ARAMEX_API
Aramex.


PIDGE
Pidge.


THAIPARCELS
TP Logistic.


PANTHER_REFERENCE_API
Panther Reference.


POSTAPLUS
Posta Plus.


BUFFALO
BUFFALO.


U_ENVIOS
U-ENVIOS.


ELITE_CO
Elite Express.


ROCHE_INTERNAL_SFTP
Roche Internal Courier.


DBSCHENKER_ICELAND
DB Schenker Iceland.


TNT_FR_REFERENCE
TNT France Reference.


NEWGISTICSAPI
Newgistics API.


GLOVO
Glovo.


GWLOGIS_API
G.I.G.


SPREETAIL_API
Spreetail.


MOOVA
Moova.


PLYCONGROUP
Plycon Transportation Group.


USPS_WEBHOOK
USPS Informed Visibility - Webhook.


REIMAGINEDELIVERY
maergo.


EDF_FTP
Eurodifarm.


DAO365
DAO365.


BIOCAIR_FTP
BioCair.


RANSA_WEBHOOK
Ransa.


SHIPXPRES
SHIPXPRESS.


COURANT_PLUS_API
Courant Plus.


SHIPA
SHIPA.


HOMELOGISTICS
Home Logistics.


DX
DX.


POSTE_ITALIANE_PACCOCELERE
Poste Italiane Paccocelere.


TOLL_WEBHOOK
Toll Group.


LCTBR_API
LCT do Brasil.


DX_FREIGHT
DX Freight.


DHL_SFTP
DHL Express.


SHIPROCKET
Shiprocket X.


UBER_WEBHOOK
Uber.


STATOVERNIGHT
Stat Overnight.


BURD
Burd Delivery.


FASTSHIP
Fastship Express.


IBVENTURE_WEBHOOK
IB Venture.


GATI_KWE_API
Gati-KWE.


CRYOPDP_FTP
CryoPDP.


HUBBED
HUBBED.


TIPSA_API
Tipsa API.


ARASKARGO
Aras Cargo.


THIJS_NL
Thijs Logistiek.


ATSHEALTHCARE_REFERENCE
ATS Healthcare.


99MINUTOS
99minutos.


HELLENIC_POST
Hellenic (Greece) Post.


HSM_GLOBAL
HSM Global.


MNX
MNX.


NMTRANSFER
N&M Transfer Co., Inc..


LOGYSTO
Logysto.


INDIA_POST_INT
India Post International.


AMAZON_FBA_SWISHIP_IN
Swiship IN.


SRT_TRANSPORT
SRT Transport.


BOMI
Bomi Group.


DELIVERR_SFTP
Deliverr.


HSDEXPRESS
HSDEXPRESS.


SIMPLETIRE_WEBHOOK
SimpleTire.


HUNTER_EXPRESS_SFTP
Hunter Express.


UPS_API
UPS.


WOOYOUNG_LOGISTICS_SFTP
WOO YOUNG LOGISTICS CO.,LTD..


PHSE_API
PHSE.


WISH_EMAIL_PUSH
Wish.


NORTHLINE
Northline.


MEDAFRICA
Med Africa Logistics.


DPD_AT_SFTP
DPD Austria.


ANTERAJA
Anteraja.


DHL_GLOBAL_FORWARDING_API
DHL Global Forwarding API.


LBCEXPRESS_API
LBC EXPRESS INC..


SIMSGLOBAL
Sims Global.


CDLDELIVERS
CDL Last Mile.


TYP
TYP.


TESTING_COURIER_WEBHOOK
Testing Courier.


PANDAGO_API
Pandago.


ROYAL_MAIL_FTP
Royal Mail.


THUNDEREXPRESS
Thunder Express Australia.


SECRETLAB_WEBHOOK
Secretlab.


SETEL
Setel Express.


JD_WORLDWIDE
JD Worldwide.


DPD_RU_API
DPD Russia.


ARGENTS_WEBHOOK
Argents Express Group.


POSTONE
Post ONE.


TUSKLOGISTICS
Tusk Logistics.


RHENUS_UK_API
Rhenus Logistics UK.


TAQBIN_SG_API
Yamato Singapore.


INNTRALOG_SFTP
Inntralog GmbH.


DAYROSS
Day & Ross.


CORREOSEXPRESS_API
Correos Express (API).


INTERNATIONAL_SEUR_API
International Seur API.


YODEL_API
Yodel API.


HEROEXPRESS
Hero Express.


DHL_SUPPLYCHAIN_IN
DHL supply chain India.


URGENT_CARGUS
Urgent Cargus.


FRONTDOORCORP
FRONTdoor Collective.


JTEXPRESS_PH
J&T Express Philippines.


PARCELSTARS_WEBHOOK
Parcelstars.


DPD_SK_SFTP
DPD Slovakia.


MOVIANTO
Movianto.


OZEPARTS_SHIPPING
Ozeparts Shipping.


KARGOMKOLAY
KargomKolay (CargoMini).


TRUNKRS
Trunkrs.


OMNIRPS_WEBHOOK
Omni Returns.


CHILEXPRESS
Chile Express.


TESTING_COURIER
Testing Courier.


JNE_API
JNE (API).


BJSHOMEDELIVERY_FTP
BJS Distribution, Storage & Couriers - FTP.


DEXPRESS_WEBHOOK
D Express.


USPS_API
USPS API.


TRANSVIRTUAL
TransVirtual.


SOLISTICA_API
solistica.


CHIENVENTURE_WEBHOOK
Chienventure.


DPD_UK_SFTP
DPD UK.


INPOST_UK
InPost.


JAVIT
Javit.


ZTO_DOMESTIC
ZTO Express China.


DHL_GT_API
DHL Global Forwarding Guatemala.


CEVA_TRACKING
CEVA Package.


KOMON_EXPRESS
Komon Express.


EASTWESTCOURIER_FTP
East West Courier Pte Ltd.


DANNIAO
Danniao.


SPECTRAN
Spectran.


DELIVER_IT
Deliver-iT.


RELAISCOLIS
Relais Colis.


GLS_SPAIN_API
GLS Spain.


POSTPLUS
PostPlus.


AIRTERRA
Airterra.


GIO_ECOURIER_API
GIO Express Ecourier.


DPD_CH_SFTP
DPD Switzerland.


FEDEX_API
FedEx®.


INTERSMARTTRANS
INTERSMARTTRANS & SOLUTIONS SL.


HERMES_UK_SFTP
Hermes UK.


EXELOT_FTP
Exelot Ltd..


DHL_PA_API
DHL GLOBAL FORWARDING PANAMÁ.


VIRTRANSPORT_SFTP
Vir Transport.


WORLDNET
Worldnet Logistics.


INSTABOX_WEBHOOK
Instabox.


KNG
Keuhne + Nagel Global.


FLASHEXPRESS_WEBHOOK
Flash Express.


MAGYAR_POSTA_API
Magyar Posta.


WESHIP_API
WeShip.


OHI_WEBHOOK
Ohi.


MUDITA
MUDITA.


BLUEDART_API
Bluedart.


T_CAT_API
T-cat.


ADS
ADS Express.


HERMES_IT
HR Parcel.


FITZMARK_API
FitzMark.


POSTI_API
Posti API.


SMSA_EXPRESS_WEBHOOK
SMSA Express.


TAMERGROUP_WEBHOOK
Tamer Logistics.


LIVRAPIDE
Livrapide.


NIPPON_EXPRESS
Nippon Express.


BETTERTRUCKS
Better Trucks.


FAN
FAN COURIER EXPRESS.


PB_USPSFLATS_FTP
USPS Flats (Pitney Bowes).


PARCELRIGHT
Parcel Right.


ITHINKLOGISTICS
iThink Logistics.


KERRY_EXPRESS_TH_WEBHOOK
Kerry Logistics.


ECOUTIER
eCoutier.


SHOWL
SENHONG INTERNATIONAL LOGISTICS.


BRT_IT_API
BRT Bartolini API.


RIXONHK_API
Rixon Logistics.


DBSCHENKER_API
DB Schenker.


ILYANGLOGIS
Ilyang logistics.


MAIL_BOX_ETC
Mail Boxes Etc..


WESHIP
WeShip.


DHL_GLOBAL_MAIL_API
DHL eCommerce Solutions.


ACTIVOS24_API
Activos24.


ATSHEALTHCARE
ATS Healthcare.


LUWJISTIK
Luwjistik.


GW_WORLD
Gebrüder Weiss.


FAIRSENDEN_API
fairsenden.


SERVIP_WEBHOOK
SerVIP.


SWISHIP
Swiship.


TANET
Transport Ambientales.


HOTSIN_CARGO
SHENZHEN HOTSIN CARGO INT'L FORWARDING CO.,LTD.


DIREX
Direx.


HUANTONG
HuanTong.


IMILE_API
iMile.


AUEXPRESS
Au Express.


NYTLOGISTICS
NYT SUPPLY CHAIN LOGISTICS Co.,LTD.


DSV_REFERENCE
DSV Futurewave.


NOVOFARMA_WEBHOOK
Novofarma.


AITWORLDWIDE_SFTP
AIT.


SHOPOLIVE
Olive.


FNF_ZA
Fast & Furious.


DHL_ECOMMERCE_GC
DHL eCommerce Greater China.


FETCHR
Fetchr.


STARLINKS_API
Starlinks Global.


YYEXPRESS
YYEXPRESS.


SERVIENTREGA
Servientrega.


HANJIN
HanJin.


SPANISH_SEUR_FTP
Spanish Seur.


DX_B2B_CONNUM
DX (B2B).


HELTHJEM_API
Helthjem.


INEXPOST
Inexpost.


A2B_BA
A2B Express Logistics.


RHENUS_GROUP
Rhenus Logistics.


SBERLOGISTICS_RU
Sber Logistics.


MALCA_AMIT
Malca-Amit.


PPL
Professional Parcel Logistics.


OSM_WORLDWIDE_SFTP
OSM Worldwide.


ACILOGISTIX
ACI Logistix.


OPTIMACOURIER
Optima Courier.


NOVA_POSHTA_API
Nova Poshta API.


LOGGI
Loggi.


YIFAN
YiFan Express.


MYDYNALOGIC
My DynaLogic.


MORNINGLOBAL
Morning Global.


CONCISE_API
Concise.


FXTRAN
Falcon Express.


DELIVERYOURPARCEL_ZA
Deliver Your Parcel.


UPARCEL
uParcel.


MOBI_BR
Mobi Logistica.


LOGINEXT_WEBHOOK
T&W Delivery.


EMS
EMS.


SPEEDY
Speedy.


ZOOM_RED
Zoom.


NAVLUNGO
Navlungo.


CASTLEPARCELS
Castle Parcels.


WEEE
Weee.


PACKALY
Packaly.


YUNHUIPOST
Yunhuipost.


YOUPARCEL
YouParcel.


LEMAN
Leman.


MOOVIN
Moovin.


URB_IT
Urb-it.


MULTIENTREGAPANAMA
Multientrega.


JUSDASR
Jusdasr.


DISCOUNTPOST
Discount Post.


RHENUS_UK
Rhenus Logistics UK.


SWISHIP_JP
Swiship JP.


GLS_US
GLS USA.


SMTL
Southwestern Motor Transport. Inc.


EMEGA
Discount Post Emega.


EXPRESSONE_SV
EXPRESSONE Slovenia.


HEPSIJET
hepsiJET.


WELIVERY
Welivery.


BRINGER
Bringer Parcel Services.


EASYROUTES
EasyRoutes.


MRW
MRW.


RPM
RPM.


DPD_PRT
DPD Portugal.


GLS_ROMANIA
GLS Romania.


LMPARCEL
LM Parcel.


GTAGSM
GTA GSM.


DOMINO
DOMINO.


ESHIPPER
eShipper.


TRANSPAK
Transpak Inc..


XINDUS
Xindus.


AOYUE
Aoyue.


EASYPARCEL
Easyparcel.


EXPRESSONE
EXPRESSONE.


SENDEO_KARGO
Sendeo Kargo.


SPEEDAF
Speedaf Express.


ETOWER
eTower.


GCX
GC Express.


NINJAVAN_VN
Ninjavan Vietnam.


ALLEGRO
Allegro.


JUMPPOINT
Jumppoint.


SHIPGLOBAL_US
ShipGlobal.


KINISI
Kinisi Transport Pty Ltd.


OAKH
Oakh Harbour Freight Lines.


AWEST
American West.


BARSAN
Barsan Global Lojistik.


ENERGOLOGISTIC
Energo Logistic.


MADROOEX
Madrooex.


GOBOLT
GoBolt.


SWISS_UNIVERSAL_EXPRESS
Swiss Universal Express.


IORDIRECT
IOR Direct Solutions.


XMSZM
xmszm.


GLS_HUN
GLS Hungary.


SENDY
Sendy Express.


BRAUNSEXPRESS
Brauns Express.


GRANDSLAMEXPRESS
Grand Slam Express.


XGS
XGS.


OTSCHILE
OTS.


PACK_UP
Pack-Up.


PARCELSTARS
Parcelstars.


TEAMEXPRESSLLC
Team Express Service LLC.


ASYADEXPRESS
Asyad Express.


TDN
TDN.


EARLYBIRD
Early Bird.


CACESA
Cacesa.


PARCELJET
Parceljet.


MNG_KARGO
MNG Kargo.


SUPERPACKLINE
Super Pac Line.


SPEEDX
SpeedX.


VESYL
Vesyl.


SKYKING
Sky King.


DIRMENSAJERIA
DIR.


NETLOGIXGROUP
Netlogix.


ZYOU
ZYEX.


JAWAR
Jawar.


AGSYSTEMS
Associate Global Systems.


GPS
GPS.


PTT_KARGO
PTT Kargo.


MAERGO
Maergo.


ARIHANTCOURIER
AICS.


VTFE
VicTas Freight Express.


YUNANT
Yunant.


URBIFY
Urbify.


PACK_MAN
pack-man.


LIEFERGRUN
LIEFERGRUN.


OBIBOX
Obibox.


PAIKEDA
Paikeda.


SCOTTY
Scotty.


INTELCOM_CA
Intelcom.


SWE
swe.


ASENDIA
Asendia Global.


DPD_AT
DPD Austria.


RELAY
Relay.


ATA
ATA.


SKYEXPRESS_INTERNATIONAL
SkyExpress Internationals.


SURAT_KARGO
Surat Kargo.


SGLINK
SG LINK.


FLEETOPTICSINC
FleetOptics.


SHOPLINE
shopline.


PIGGYSHIP
PIGGYSHIP.


LOGOIX
LogoiX.


KOLAY_GELSIN
Kolay Gelsin.


ASSOCIATED_COURIERS
Associated Couriers.


UPS_CHECKER
ups-checker.


WINESHIPPING
Wineshipping.


SPEDISCI
Spedisci online.


 
"DPD_RU"
charge_pattern
Expected business/pricing model for the billing agreement.


string (charge_pattern)   [ 1 .. 30 ] characters ^[A-Z0-9_]+$
Expected business/pricing model for the billing agreement.


 Enum Value Description
IMMEDIATE
On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency.


DEFERRED
Pay after use, non-recurring post-paid, variable amount, irregular frequency.


RECURRING_PREPAID
Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered.


RECURRING_POSTPAID
Pay on a fixed date based on usage or consumption after the goods/service is delivered.


THRESHOLD_PREPAID
Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered.


THRESHOLD_POSTPAID
Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered.


SUBSCRIPTION_PREPAID
Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due before the good/service is delivered.


SUBSCRIPTION_POSTPAID
Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due after the goods/services are delivered.


UNSCHEDULED_PREPAID
Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans.


UNSCHEDULED_POSTPAID
Unscheduled card on file plan where the merchant can bill buyer based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans.


INSTALLMENT_PREPAID
Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due before the good/service is delivered.


INSTALLMENT_POSTPAID
Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered.


 
"IMMEDIATE"
checkout_payment_intent
The intent to either capture payment immediately or authorize a payment for an order after order creation.


string (checkout_payment_intent) 
The intent to either capture payment immediately or authorize a payment for an order after order creation.


 Enum Value Description
CAPTURE
The merchant intends to capture payment immediately after the customer makes a payment.


AUTHORIZE
The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one purchase_unit within your order.


 
"CAPTURE"
cobranded_card
Details about the merchant cobranded card used for order purchase.


labels
Array of strings  [ 1 .. 25 ] items 
Array of labels for the cobranded card.


 
object (payee_base) 
Merchant associated with the purchase.


 
object (Money) 
Amount that was charged to the cobranded card.


 
{
  • "labels": [
    • "string"
    ],
  • "payee": {
    • "email_address": "string",
    • "merchant_id": "string"
    },
  • "amount": {
    • "currency_code": "str",
    • "value": "string"
    }
}
confirm_order_request
Payer confirms the intent to pay for the Order using the provided payment source.


object (Order Confirm Application Context) 
Customizes the payer confirmation experience.


 
required
object (payment_source) 
The payment source definition.


 
{
  • "application_context": {
    • "brand_name": "string",
    • "return_url": "http://example.com",
    • "cancel_url": "http://example.com",
    • "locale": "string",
    • "stored_payment_source": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        }
      }
    },
  • "payment_source": {
    • "card": {
      • "name": "string",
      • "number": "stringstrings",
      • "security_code": "stri",
      • "expiry": "string",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          },
        • "verification": {
          • "method": "SCA_ALWAYS"
          }
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "vault_id": "string",
      • "single_use_token": "string",
      • "network_token": {
        • "number": "stringstrings",
        • "cryptogram": "stringstringstringstringstri",
        • "token_requestor_id": "string",
        • "expiry": "string",
        • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION"
        },
      • "experience_context": {
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "token": {
      • "id": "string",
      • "type": "BILLING_AGREEMENT"
      },
    • "paypal": {
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "contact_preference": "NO_CONTACT_INFO",
        • "landing_page": "LOGIN",
        • "user_action": "CONTINUE",
        • "payment_method_preference": "UNRESTRICTED",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string",
        • "order_update_callback_config": {}
        },
      • "billing_agreement_id": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "charge_pattern": "IMMEDIATE",
        • "usage_pattern": "IMMEDIATE",
        • "usage": "FIRST"
        },
      • "vault_id": "string",
      • "email_address": "string",
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        },
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "birth_date": "stringstri",
      • "tax_info": {
        • "tax_id": "string",
        • "tax_id_type": "BR_CPF"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "string",
          • "usage_type": "string",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        }
      },
    • "bancontact": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "blik": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string",
        • "consumer_user_agent": "string",
        • "consumer_ip": "string"
        },
      • "level_0": {
        • "auth_code": "string"
        },
      • "one_click": {
        • "auth_code": "string",
        • "consumer_reference": "string",
        • "alias_label": "stringst",
        • "alias_key": "string"
        }
      },
    • "eps": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "giropay": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "ideal": {
      • "name": "string",
      • "country_code": "string",
      • "bic": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "mybank": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "p24": {
      • "name": "string",
      • "email": "string",
      • "country_code": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "sofort": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "trustly": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "apple_pay": {
      • "id": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          }
        },
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "national_number": "string"
        },
      • "decrypted_token": {
        • "device_manufacturer_id": "string",
        • "payment_data_type": "3DSECURE",
        • "transaction_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "tokenized_card": {
          • "name": "string",
          • "number": "stringstrings",
          • "expiry": "string",
          • "card_type": "VISA",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st"
            }
          },
        • "payment_data": {
          • "cryptogram": "string",
          • "eci_indicator": "string",
          • "emv_data": "string",
          • "pin": "string"
          }
        },
      • "vault_id": "string",
      • "experience_context": {
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "google_pay": {
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "country_code": "str",
        • "national_number": "string"
        },
      • "card": {
        • "name": "string",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        },
      • "decrypted_token": {
        • "message_id": "string",
        • "message_expiration": "stringstrings",
        • "payment_method": "CARD",
        • "authentication_method": "PAN_ONLY",
        • "cryptogram": "string",
        • "eci_indicator": "string",
        • "card": {
          • "name": "string",
          • "number": "stringstrings",
          • "last_digits": "stri",
          • "expiry": "string",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st"
            }
          }
        },
      • "assurance_details": {
        • "account_verified": false,
        • "card_holder_authenticated": false
        },
      • "experience_context": {
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "venmo": {
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "order_update_callback_config": {}
        },
      • "vault_id": "string",
      • "email_address": "string",
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "string",
          • "usage_type": "string",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        }
      }
    }
}
country_code
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
"st"
country_code
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
"st"
country_code
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
"st"
currency_code
The three-character ISO-4217 currency code that identifies the currency.


string <ppaas_common_currency_code_v2>  (currency_code)   = 3 characters 
The three-character ISO-4217 currency code that identifies the currency.


 
"str"
currency_code
The 3-character ISO-4217 currency code that identifies the currency.


string <ppaas_common_currency_code_v2>  (currency_code)   = 3 characters 
The 3-character ISO-4217 currency code that identifies the currency.


 
"str"
customer
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.


id
string (merchant_partner_customer_id)   [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.


 
object (Name) 
The full name of the customer as provided to the merchant or on file with the merchant.


 
{
  • "id": "string",
  • "name": {
    • "given_name": "string",
    • "surname": "string"
    }
}
customer
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.


id
string (merchant_partner_customer_id)   [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.


 
email_address
string <merchant_common_email_address_v2>  (email)   [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...
Email address of the customer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants.


 
object (phone_with_type) 
The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.


 
object (Name) 
The full name of the customer as provided to the merchant or on file with the merchant.


 
{
  • "id": "string",
  • "email_address": "string",
  • "phone": {
    • "phone_type": "FAX",
    • "phone_number": {
      • "national_number": "string"
      }
    },
  • "name": {
    • "given_name": "string",
    • "surname": "string"
    }
}
date_no_time
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.


string <ppaas_date_notime_v2>  (date_no_time)   = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.


 
"stringstri"
date_no_time
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.


string <ppaas_date_notime_v2>  (date_no_time)   = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.


 
"stringstri"
date_no_time
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.


string <ppaas_date_notime_v2>  (date_no_time)   = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.


 
"stringstri"
date_no_time
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.


string <ppaas_date_notime_v2>  (date_no_time)   = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.


 
"stringstri"
date_time
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.


string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.


 
"stringstringstringst"
date_time
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.


string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.


 
"stringstringstringst"
date_time
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.


string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.


 
"stringstringstringst"
date_year_month
The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.


string (date_year_month)   = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.


 
"strings"
date_year_month
The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.


string (date_year_month)   = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.


 
"strings"
disbursement_mode
The funds that are held on behalf of the merchant.


string (disbursement_mode)   [ 1 .. 16 ] characters ^[A-Z_]+$
 Default:  "INSTANT"
The funds that are held on behalf of the merchant.


 Enum Value Description
INSTANT
The funds are released to the merchant immediately.


DELAYED
The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration.


 
"INSTANT"
eci_flag
Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.


string (eci_flag)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.


 Enum Value Description
MASTERCARD_NON_3D_SECURE_TRANSACTION
Mastercard non-3-D Secure transaction.


MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION
Mastercard attempted authentication transaction.


MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION
Mastercard fully authenticated transaction.


FULLY_AUTHENTICATED_TRANSACTION
VISA, AMEX, JCB, DINERS CLUB fully authenticated transaction.


ATTEMPTED_AUTHENTICATION_TRANSACTION
VISA, AMEX, JCB, DINERS CLUB attempted authentication transaction.


NON_3D_SECURE_TRANSACTION
VISA, AMEX, JCB, DINERS CLUB non-3-D Secure transaction.


 
"MASTERCARD_NON_3D_SECURE_TRANSACTION"
email
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.


string <merchant_common_email_address_v2>  (email)   [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.


 
"string"
email_address
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.


string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.


 
"string"
email_address
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.


string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.


 
"string"
enrolled
Status of Authentication eligibility.


string (enrolled)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Status of Authentication eligibility.


 Enum Value Description
Y
Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl.


N
No. The bank is not participating in 3-D Secure protocol.


U
Unavailable. The DS or ACS is not available for authentication at the time of the request.


B
Bypass. The merchant authentication rule is triggered to bypass authentication.


 
"Y"
eps
Information used to pay using eps.


name
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The bank identification code (BIC).


 
{
  • "name": "string",
  • "country_code": "string",
  • "bic": "string"
}
eps_request
Information needed to pay using eps.


name
required
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "experience_context": {
    • "brand_name": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "locale": "string",
    • "return_url": "string",
    • "cancel_url": "string"
    }
}
Error
The error details.


name
required
string
The human-readable, unique name of the error.


 
message
required
string
The message that describes the error.


 
debug_id
required
string
The PayPal internal ID. Used for correlation purposes.


 
Array of objects (Error Details) 
An array of additional details about the error.


 
Array of objects (Link Description) 
An array of request-related HATEOAS links.


 
{
  • "name": "string",
  • "message": "string",
  • "debug_id": "string",
  • "details": [
    • {
      • "field": "string",
      • "value": "string",
      • "location": "body",
      • "issue": "string",
      • "links": [
        • {
          • "href": "string",
          • "rel": "string",
          • "method": "GET"
          }
        ],
      • "description": "string"
      }
    ],
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ]
}
Error Details
The error details. Required for client-side 4XX errors.


field
string
The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.


 
value
string
The value of the field that caused the error.


 
location
string
 Default:  "body"
The location of the field that caused the error. Value is body, path, or query.


 
issue
required
string
The unique, fine-grained application-level error code.


 
Array of objects (Link Description)   [ 1 .. 4 ] items 
An array of request-related HATEOAS links that are either relevant to the issue by providing additional information or offering potential resolutions.


 
description
string
The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value.


 
{
  • "field": "string",
  • "value": "string",
  • "location": "body",
  • "issue": "string",
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ],
  • "description": "string"
}
exchange_rate
The exchange rate that determines the amount to convert from one currency to another currency.


value
string
The target currency amount. Equivalent to one unit of the source currency. Formatted as integer or decimal value with one to 15 digits to the right of the decimal point.


 
source_currency
string <ppaas_common_currency_code_v2>  (currency_code)   = 3 characters 
The source currency from which to convert an amount.


 
target_currency
string <ppaas_common_currency_code_v2>  (currency_code)   = 3 characters 
The target currency to which to convert an amount.


 
{
  • "value": "string",
  • "source_currency": "str",
  • "target_currency": "str"
}
experience_context_base
Customizes the payer experience during the approval process for the payment.


brand_name
string  [ 1 .. 127 ] characters ^.*$
The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.


 
shipping_preference
string  [ 1 .. 24 ] characters ^[A-Z_]+$
 Default:  "GET_FROM_FILE"
The location from which the shipping address is derived.


 Enum Value Description
GET_FROM_FILE
Get the customer-provided shipping address on the PayPal site.


NO_SHIPPING
Redacts the shipping address from the PayPal site. Recommended for digital goods.


SET_PROVIDED_ADDRESS
Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages.


 
locale
string <ppaas_common_language_v3>  (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.


 
return_url
string <uri>  (url) 
The URL where the customer is redirected after the customer approves the payment.


 
cancel_url
string <uri>  (url) 
The URL where the customer is redirected after the customer cancels the payment.


 
{
  • "brand_name": "string",
  • "shipping_preference": "GET_FROM_FILE",
  • "locale": "string",
  • "return_url": "string",
  • "cancel_url": "string"
}
experience_context_base
Customizes the payer experience during the approval process for the payment.


locale
string <ppaas_common_language_v3>  (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.


 
return_url
string <uri>  (url) 
The URL where the customer is redirected after the customer approves the payment.


 
cancel_url
string <uri>  (url) 
The URL where the customer is redirected after the customer cancels the payment.


 
{
  • "locale": "string",
  • "return_url": "string",
  • "cancel_url": "string"
}
giropay
Information needed to pay using giropay.


name
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The bank identification code (BIC).


 
{
  • "name": "string",
  • "country_code": "string",
  • "bic": "string"
}
giropay_request
Information needed to pay using giropay.


name
required
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "experience_context": {
    • "brand_name": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "locale": "string",
    • "return_url": "string",
    • "cancel_url": "string"
    }
}
google_pay
Google Pay Wallet payment data.


name
string (name)   [ 3 .. 300 ] characters 
Name on the account holder associated with Google Pay.


 
email_address
string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The email address of the account holder associated with Google Pay.


 
object (Phone) 
The phone number of account holder, in its canonical international E.164 numbering plan format. Supports only the national_number property.


 
object (google_pay_card_response) 
The Card from Google Pay Wallet used to fund the payment.


 
{
  • "name": "string",
  • "email_address": "string",
  • "phone_number": {
    • "country_code": "str",
    • "national_number": "string"
    },
  • "card": {
    • "name": "string",
    • "last_digits": "stri",
    • "type": "CREDIT",
    • "brand": "VISA",
    • "billing_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      },
    • "authentication_result": {
      • "liability_shift": "NO",
      • "three_d_secure": {
        • "authentication_status": "Y",
        • "enrollment_status": "Y"
        }
      }
    }
}
google_pay_card
The payment card used to fund a Google Pay payment. Can be a credit or debit card.


name
string  [ 1 .. 300 ] characters ^.{1,300}$
The card holder's name as it appears on the card.


 
type
string (card_type)   [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.


 Enum Value Description
CREDIT
A credit card.


DEBIT
A debit card.


PREPAID
A Prepaid card.


STORE
A store card.


UNKNOWN
Card type cannot be determined.


 
brand
string (card_brand)   [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.


 Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
object (Portable Postal Address (Medium-Grained)) 
The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.


 
{
  • "name": "string",
  • "type": "CREDIT",
  • "brand": "VISA",
  • "billing_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    }
}
google_pay_card
The payment card used to fund a Google Pay payment. Can be a credit or debit card.


name
string  [ 1 .. 300 ] characters ^.{1,300}$
The card holder's name as it appears on the card.


 
number
required
string  [ 13 .. 19 ] characters ^[0-9]{13,19}$
The primary account number (PAN) for the payment card.


 
last_digits
string  [ 2 .. 4 ] characters ^[0-9]{2,4}$
The last digits of the payment card.


 
expiry
required
string (date_year_month)   = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format.


 
type
string (card_type)   [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.


 Enum Value Description
CREDIT
A credit card.


DEBIT
A debit card.


PREPAID
A Prepaid card.


STORE
A store card.


UNKNOWN
Card type cannot be determined.


 
brand
string (card_brand)   [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.


 Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
object (Portable Postal Address (Medium-Grained)) 
The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.


 
{
  • "name": "string",
  • "number": "stringstrings",
  • "last_digits": "stri",
  • "expiry": "string",
  • "type": "CREDIT",
  • "brand": "VISA",
  • "billing_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    }
}
google_pay_card_response
The payment card to use to fund a Google Pay payment response. Can be a credit or debit card.


name
string  [ 1 .. 300 ] characters ^.{1,300}$
The card holder's name as it appears on the card.


 
last_digits
string  [ 2 .. 4 ] characters ^[0-9]{2,4}$
The last digits of the payment card.


 
type
string (card_type)   [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.


 Enum Value Description
CREDIT
A credit card.


DEBIT
A debit card.


PREPAID
A Prepaid card.


STORE
A store card.


UNKNOWN
Card type cannot be determined.


 
brand
string (card_brand)   [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.


 Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
object (Portable Postal Address (Medium-Grained)) 
The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.


 
object (authentication_response) 
Results of Authentication such as 3D Secure.


 
{
  • "name": "string",
  • "last_digits": "stri",
  • "type": "CREDIT",
  • "brand": "VISA",
  • "billing_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    },
  • "authentication_result": {
    • "liability_shift": "NO",
    • "three_d_secure": {
      • "authentication_status": "Y",
      • "enrollment_status": "Y"
      }
    }
}
google_pay_decrypted_token_data
Details shared by Google for the merchant to be shared with PayPal. This is required to process the transaction using the Google Pay payment method.


message_id
string  [ 1 .. 250 ] characters ^.*$
A unique ID that identifies the message in case it needs to be revoked or located at a later time.


 
message_expiration
string  = 13 characters \d{13}
Date and time at which the message expires as UTC milliseconds since epoch. Integrators should reject any message that's expired.


 
payment_method
required
string  = 4 characters 
The type of the payment credential. Currently, only CARD is supported.


 Value Description
CARD
CARD is the only value that Google Pay accepts.


 
authentication_method
required
string  [ 1 .. 50 ] characters 
Authentication Method which is used for the card transaction.


 Enum Value Description
PAN_ONLY
This authentication method is associated with payment cards stored on file with the user's Google Account. Returned payment data includes primary account number (PAN) with the expiration month and the expiration year.


CRYPTOGRAM_3DS
Returned payment data includes a 3-D Secure (3DS) cryptogram generated on the device. -> If authentication_method=CRYPTOGRAM, it is required that 'cryptogram' parameter in the request has a valid 3-D Secure (3DS) cryptogram generated on the device.


 
cryptogram
string  [ 1 .. 2000 ] characters 
Base-64 cryptographic identifier used by card schemes to validate the token verification result. This is a conditionally required field if authentication_method is CRYPTOGRAM_3DS.


 
eci_indicator
string  [ 1 .. 256 ] characters ^.*$
Electronic Commerce Indicator may not always be present. It is only returned for tokens on the Visa card network. This value is passed through in the payment authorization request.


 
required
object (google_pay_card) 
Google Pay tokenized credit card used to pay.


 
{
  • "message_id": "string",
  • "message_expiration": "stringstrings",
  • "payment_method": "CARD",
  • "authentication_method": "PAN_ONLY",
  • "cryptogram": "string",
  • "eci_indicator": "string",
  • "card": {
    • "name": "string",
    • "number": "stringstrings",
    • "last_digits": "stri",
    • "expiry": "string",
    • "type": "CREDIT",
    • "brand": "VISA",
    • "billing_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      }
    }
}
google_pay_experience_context
Customizes the payer experience during the approval process for the payment.


return_url
required
string <uri>  (url) 
The URL where the customer is redirected after the customer approves the payment.


 
cancel_url
required
string <uri>  (url) 
The URL where the customer is redirected after the customer cancels the payment.


 
{
  • "return_url": "string",
  • "cancel_url": "string"
}
google_pay_request
Information needed to pay using Google Pay.


name
string (name)   [ 3 .. 300 ] characters 
Name on the account holder associated with Google Pay.


 
email_address
string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The email address of the account holder associated with Google Pay.


 
object (Phone) 
The phone number of account holder, in its canonical international E.164 numbering plan format. Supports only the national_number property.


 
object (google_pay_card) 
The payment card information.


 
object (google_pay_decrypted_token_data) 
The decrypted payload details for the Google Pay token.


 
object (assurance_details) 
Information about what validation has been performed on the returned payment credentials.


 
object (google_pay_experience_context) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "email_address": "string",
  • "phone_number": {
    • "country_code": "str",
    • "national_number": "string"
    },
  • "card": {
    • "name": "string",
    • "type": "CREDIT",
    • "brand": "VISA",
    • "billing_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      }
    },
  • "decrypted_token": {
    • "message_id": "string",
    • "message_expiration": "stringstrings",
    • "payment_method": "CARD",
    • "authentication_method": "PAN_ONLY",
    • "cryptogram": "string",
    • "eci_indicator": "string",
    • "card": {
      • "name": "string",
      • "number": "stringstrings",
      • "last_digits": "stri",
      • "expiry": "string",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        }
      }
    },
  • "assurance_details": {
    • "account_verified": false,
    • "card_holder_authenticated": false
    },
  • "experience_context": {
    • "return_url": "string",
    • "cancel_url": "string"
    }
}
iban_last_chars
The last characters of the IBAN used to pay.


string (iban_last_chars)   [ 4 .. 34 ] characters [a-zA-Z0-9]{4}
The last characters of the IBAN used to pay.


 
"string"
ideal
Information used to pay using iDEAL.


name
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The bank identification code (BIC).


 
iban_last_chars
string (iban_last_chars)   [ 4 .. 34 ] characters [a-zA-Z0-9]{4}
The last characters of the IBAN used to pay.


 
{
  • "name": "string",
  • "country_code": "string",
  • "bic": "string",
  • "iban_last_chars": "string"
}
ideal_request
Information needed to pay using iDEAL.


name
required
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The bank identification code (BIC).


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "bic": "string",
  • "experience_context": {
    • "brand_name": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "locale": "string",
    • "return_url": "string",
    • "cancel_url": "string"
    }
}
instrument_id
The identifier of the instrument.


string (instrument_id)   [ 1 .. 256 ] characters ^[A-Za-z0-9-_.+=]+$
The identifier of the instrument.


 
"string"
IP Address
An Internet Protocol address (IP address). This address assigns a numerical label to each device that is connected to a computer network through the Internet Protocol. Supports IPv4 and IPv6 addresses.


string <ppaas_ip_address_v1>  (IP Address)   [ 7 .. 39 ] characters ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...
An Internet Protocol address (IP address). This address assigns a numerical label to each device that is connected to a computer network through the Internet Protocol. Supports IPv4 and IPv6 addresses.


 
"strings"
item
The details for the items to be purchased.


name
required
string  [ 1 .. 127 ] characters 
The item name or title.


 
quantity
required
string  <= 10 characters ^[1-9][0-9]{0,9}$
The item quantity. Must be a whole number.


 
description
string  <= 2048 characters 
The detailed item description.


 
sku
string  <= 127 characters 
The stock keeping unit (SKU) for the item.


 
url
string <uri>   [ 1 .. 2048 ] characters 
The URL to the item being purchased. Visible to buyer and used in buyer experiences.


 
category
string  [ 1 .. 20 ] characters 
The item category type.


 Enum Value Description
DIGITAL_GOODS
Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the PayPal for Commerce Platform product.


PHYSICAL_GOODS
A tangible item that can be shipped with proof of delivery.


DONATION
A contribution or gift for which no good or service is exchanged, usually to a not for profit organization.


 
image_url
string <uri>   [ 1 .. 2048 ] characters ^(https:)([/|.|\w|\s|-])*\.(?:jpg|gif|png|jpe...
The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.


 
required
object (Money) 
The item price or rate per unit. If you specify unit_amount, purchase_units[].amount.breakdown.item_total is required. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number.


 
object (Money) 
The item tax for each unit. If tax is specified, purchase_units[].amount.breakdown.tax_total is required. Must equal tax * quantity for all items. tax.value can not be a negative number.


 
object (universal_product_code) 
The Universal Product Code of the item.


 
object (order_billing_plan) 
Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.


 
{
  • "name": "string",
  • "quantity": "string",
  • "description": "string",
  • "sku": "string",
  • "url": "http://example.com",
  • "category": "DIGITAL_GOODS",
  • "image_url": "http://example.com",
  • "unit_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "tax": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "upc": {
    • "type": "UPC-A",
    • "code": "string"
    },
  • "billing_plan": {
    • "billing_cycles": [
      • {
        • "tenure_type": "REGULAR",
        • "total_cycles": 1,
        • "sequence": 1,
        • "pricing_scheme": {
          • "pricing_model": "FIXED",
          • "price": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "reload_threshold_amount": {
            • "currency_code": "str",
            • "value": "string"
            }
          },
        • "start_date": "string"
        }
      ],
    • "name": "string",
    • "setup_fee": {
      • "currency_code": "str",
      • "value": "string"
      }
    }
}
item
The details for the items to be purchased.


name
required
string  [ 1 .. 127 ] characters 
The item name or title.


 
quantity
required
string  <= 10 characters ^[1-9][0-9]{0,9}$
The item quantity. Must be a whole number.


 
description
string  <= 2048 characters 
The detailed item description.


 
sku
string  <= 127 characters 
The stock keeping unit (SKU) for the item.


 
url
string <uri>   [ 1 .. 2048 ] characters 
The URL to the item being purchased. Visible to buyer and used in buyer experiences.


 
image_url
string <uri>   [ 1 .. 2048 ] characters ^(https:)([/|.|\w|\s|-])*\.(?:jpg|gif|png|jpe...
The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.


 
object (universal_product_code) 
The Universal Product Code of the item.


 
object (order_billing_plan) 
Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.


 
{
  • "name": "string",
  • "quantity": "string",
  • "description": "string",
  • "sku": "string",
  • "url": "http://example.com",
  • "image_url": "http://example.com",
  • "upc": {
    • "type": "UPC-A",
    • "code": "string"
    },
  • "billing_plan": {
    • "billing_cycles": [
      • {
        • "tenure_type": "REGULAR",
        • "total_cycles": 1,
        • "sequence": 1,
        • "pricing_scheme": {
          • "pricing_model": "FIXED",
          • "price": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "reload_threshold_amount": {
            • "currency_code": "str",
            • "value": "string"
            }
          },
        • "start_date": "string"
        }
      ],
    • "name": "string",
    • "setup_fee": {
      • "currency_code": "str",
      • "value": "string"
      }
    }
}
language
The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.


string <ppaas_common_language_v3>  (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.


 
"string"
language
The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.


string <ppaas_common_language_v3>  (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.


 
"string"
level_2
The level 2 card processing data collections. If your merchant account has been configured for Level 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 2 data for your business.


invoice_id
string  [ 1 .. 127 ] characters ^[\w‘\-.,":;\!?]*$
Use this field to pass a purchase identification value of up to 127 ASCII characters. The length of this field will be adjusted to meet network specifications (25chars for Visa and Mastercard, 17chars for Amex), and the original invoice ID will still be displayed in your existing reports.


 
object (Money) 
Use this field to break down the amount of tax included in the total purchase amount. The value provided here will not add to the total purchase amount. The value can't be negative, and in most cases, it must be greater than zero in order to qualify for lower interchange rates. 
 Value, by country, is:


UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.



 
{
  • "invoice_id": "string",
  • "tax_total": {
    • "currency_code": "str",
    • "value": "string"
    }
}
level_3
The level 3 card processing data collections, If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 3 data for your business.


ships_from_postal_code
string  [ 1 .. 60 ] characters ^[a-zA-Z0-9_'.-]*$
Use this field to specify the postal code of the shipping location.


 
Array of objects (line_item)   [ 1 .. 100 ] items 
A list of the items that were purchased with this payment. If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf.


 
object (Money) 
Use this field to break down the shipping cost included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.


 
object (Money) 
Use this field to break down the duty amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.


 
object (Money) 
Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.


 
object (Portable Postal Address (Medium-Grained)) 
The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.


 
{
  • "ships_from_postal_code": "string",
  • "line_items": [
    • {
      • "name": "string",
      • "quantity": "string",
      • "description": "string",
      • "sku": "string",
      • "url": "http://example.com",
      • "image_url": "http://example.com",
      • "upc": {
        • "type": "UPC-A",
        • "code": "string"
        },
      • "billing_plan": {
        • "billing_cycles": [
          • {
            • "tenure_type": "REGULAR",
            • "total_cycles": 1,
            • "sequence": 1,
            • "pricing_scheme": {
              • "pricing_model": "FIXED",
              • "price": {
                • "currency_code": null,
                • "value": null
                },
              • "reload_threshold_amount": {
                • "currency_code": null,
                • "value": null
                }
              },
            • "start_date": "string"
            }
          ],
        • "name": "string",
        • "setup_fee": {
          • "currency_code": "str",
          • "value": "string"
          }
        },
      • "commodity_code": "string",
      • "unit_of_measure": "string",
      • "unit_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "tax": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "discount_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "total_amount": {
        • "currency_code": "str",
        • "value": "string"
        }
      }
    ],
  • "shipping_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "duty_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "discount_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "shipping_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    }
}
liability_shift
Liability shift indicator. The outcome of the issuer's authentication.


string (liability_shift)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Liability shift indicator. The outcome of the issuer's authentication.


 Enum Value Description
NO
Liability is with the merchant.


POSSIBLE
Liability may shift to the card issuer.


UNKNOWN
The authentication system is not available.


 
"NO"
line_item
The line items for this purchase. If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf.


name
required
string  [ 1 .. 127 ] characters 
The item name or title.


 
quantity
required
string  <= 10 characters ^[1-9][0-9]{0,9}$
The item quantity. Must be a whole number.


 
description
string  <= 2048 characters 
The detailed item description.


 
sku
string  <= 127 characters 
The stock keeping unit (SKU) for the item.


 
url
string <uri>   [ 1 .. 2048 ] characters 
The URL to the item being purchased. Visible to buyer and used in buyer experiences.


 
image_url
string <uri>   [ 1 .. 2048 ] characters ^(https:)([/|.|\w|\s|-])*\.(?:jpg|gif|png|jpe...
The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.


 
object (universal_product_code) 
The Universal Product Code of the item.


 
object (order_billing_plan) 
Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.


 
commodity_code
string  [ 1 .. 12 ] characters ^[a-zA-Z0-9_'.-]*$
Code used to classify items purchased and track the total amount spent across various categories of products and services. Different corporate purchasing organizations may use different standards, but the United Nations Standard Products and Services Code (UNSPSC) is frequently used.


 
unit_of_measure
string  [ 1 .. 12 ] characters ^[a-zA-Z0-9_'.-]*$
Unit of measure is a standard used to express the magnitude of a quantity in international trade. Most commonly used (but not limited to) examples are: Acre (ACR), Ampere (AMP), Centigram (CGM), Centimetre (CMT), Cubic inch (INQ), Cubic metre (MTQ), Fluid ounce (OZA), Foot (FOT), Hour (HUR), Item (ITM), Kilogram (KGM), Kilometre (KMT), Kilowatt (KWT), Liquid gallon (GLL), Liter (LTR), Pounds (LBS), Square foot (FTK).


 
required
object (Money) 
The item price or rate per unit. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number.


 
object (Money) 
The item tax for each unit. Must equal tax * quantity for all items. tax.value can not be a negative number.


 
object (Money) 
Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.


 
object (Money) 
The subtotal for all items. Must equal the sum of (items[].unit_amount * items[].quantity) for all items. item_total.value can not be a negative number.


 
{
  • "name": "string",
  • "quantity": "string",
  • "description": "string",
  • "sku": "string",
  • "url": "http://example.com",
  • "image_url": "http://example.com",
  • "upc": {
    • "type": "UPC-A",
    • "code": "string"
    },
  • "billing_plan": {
    • "billing_cycles": [
      • {
        • "tenure_type": "REGULAR",
        • "total_cycles": 1,
        • "sequence": 1,
        • "pricing_scheme": {
          • "pricing_model": "FIXED",
          • "price": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "reload_threshold_amount": {
            • "currency_code": "str",
            • "value": "string"
            }
          },
        • "start_date": "string"
        }
      ],
    • "name": "string",
    • "setup_fee": {
      • "currency_code": "str",
      • "value": "string"
      }
    },
  • "commodity_code": "string",
  • "unit_of_measure": "string",
  • "unit_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "tax": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "discount_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "total_amount": {
    • "currency_code": "str",
    • "value": "string"
    }
}
merchant_partner_customer_id
The unique ID for a customer generated by PayPal.


string (merchant_partner_customer_id)   [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.


 
"string"
Money
The currency and amount for a financial transaction, such as a balance or payment due.


currency_code
required
string <ppaas_common_currency_code_v2>  (currency_code)   = 3 characters 
The three-character ISO-4217 currency code that identifies the currency.


 
value
required
string  <= 32 characters ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be:
  • An integer for currencies like JPY that are not typically fractional.
  • A decimal fraction for currencies like TND that are subdivided into thousandths.
For the required number of decimal places for a currency code, see Currency Codes.


 
{
  • "currency_code": "str",
  • "value": "string"
}
Money
The currency and amount for a financial transaction, such as a balance or payment due.


currency_code
required
string <ppaas_common_currency_code_v2>  (currency_code)   = 3 characters 
The 3-character ISO-4217 currency code that identifies the currency.


 
value
required
string  <= 32 characters ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be:
  • An integer for currencies like JPY that are not typically fractional.
  • A decimal fraction for currencies like TND that are subdivided into thousandths.
For the required number of decimal places for a currency code, see Currency Codes.


 
{
  • "currency_code": "str",
  • "value": "string"
}
mybank
Information used to pay using MyBank.


name
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The bank identification code (BIC).


 
iban_last_chars
string (iban_last_chars)   [ 4 .. 34 ] characters [a-zA-Z0-9]{4}
The last characters of the IBAN used to pay.


 
{
  • "name": "string",
  • "country_code": "string",
  • "bic": "string",
  • "iban_last_chars": "string"
}
mybank_request
Information needed to pay using MyBank.


name
required
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "experience_context": {
    • "brand_name": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "locale": "string",
    • "return_url": "string",
    • "cancel_url": "string"
    }
}
name
The full name representation like Mr J Smith.


string (name)   [ 3 .. 300 ] characters 
The full name representation like Mr J Smith.


 
"string"
Name
The name of the party.


given_name
string  <= 140 characters 
When the party is a person, the party's given, or first, name.


 
surname
string  <= 140 characters 
When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.


 
{
  • "given_name": "string",
  • "surname": "string"
}
Name
The name of the party.


given_name
string  <= 140 characters 
When the party is a person, the party's given, or first, name.


 
surname
string  <= 140 characters 
When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.


 
{
  • "given_name": "string",
  • "surname": "string"
}
Name
The name of the party.


given_name
string  <= 140 characters 
When the party is a person, the party's given, or first, name.


 
surname
string  <= 140 characters 
When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.


 
{
  • "given_name": "string",
  • "surname": "string"
}
Name
The name of the party.


given_name
string  <= 140 characters 
When the party is a person, the party's given, or first, name.


 
surname
string  <= 140 characters 
When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.


 
{
  • "given_name": "string",
  • "surname": "string"
}
Name
The name of the party.


full_name
string  <= 300 characters 
When the party is a person, the party's full name.


 
{
  • "full_name": "string"
}
Name
The name of the party.


given_name
string  <= 140 characters 
When the party is a person, the party's given, or first, name.


 
surname
string  <= 140 characters 
When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.


 
{
  • "given_name": "string",
  • "surname": "string"
}
Name
The name of the party.


given_name
string  <= 140 characters 
When the party is a person, the party's given, or first, name.


 
surname
string  <= 140 characters 
When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.


 
{
  • "given_name": "string",
  • "surname": "string"
}
net_amount_breakdown
The net amount. Returned when the currency of the refund is different from the currency of the PayPal account where the merchant holds their funds.


object (Money) 
The net amount debited from the merchant's PayPal account.


 
object (Money) 
The converted payable amount.


 
object (exchange_rate) 
The exchange rate that determines the amount that was debited from the merchant's PayPal account.


 
{
  • "payable_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "converted_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "exchange_rate": {
    • "value": "string",
    • "source_currency": "str",
    • "target_currency": "str"
    }
}
network_token
The Third Party Network token used to fund a payment.


number
required
string  [ 13 .. 19 ] characters ^[0-9]{13,19}$
Third party network token number.


 
cryptogram
string  [ 28 .. 32 ] characters ^.*$
An Encrypted one-time use value that's sent along with Network Token. This field is not required to be present for recurring transactions.


 
token_requestor_id
string  [ 1 .. 11 ] characters ^[0-9A-Z_]+$
A TRID, or a Token Requestor ID, is an identifier used by merchants to request network tokens from card networks. A TRID is a precursor to obtaining a network token for a credit card primary account number (PAN), and will aid in enabling secure card on file (COF) payments and reducing fraud.


 
expiry
required
string (date_year_month)   = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format.


 
eci_flag
string (eci_flag)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.


 Enum Value Description
MASTERCARD_NON_3D_SECURE_TRANSACTION
Mastercard non-3-D Secure transaction.


MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION
Mastercard attempted authentication transaction.


MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION
Mastercard fully authenticated transaction.


FULLY_AUTHENTICATED_TRANSACTION
VISA, AMEX, JCB, DINERS CLUB fully authenticated transaction.


ATTEMPTED_AUTHENTICATION_TRANSACTION
VISA, AMEX, JCB, DINERS CLUB attempted authentication transaction.


NON_3D_SECURE_TRANSACTION
VISA, AMEX, JCB, DINERS CLUB non-3-D Secure transaction.


 
{
  • "number": "stringstrings",
  • "cryptogram": "stringstringstringstringstri",
  • "token_requestor_id": "string",
  • "expiry": "string",
  • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION"
}
network_transaction
Reference values used by the card network to identify a transaction.


id
string  [ 9 .. 36 ] characters ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$
Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -.


 
date
string  = 4 characters ^[0-9]+$
The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date.


 
acquirer_reference_number
string  [ 1 .. 36 ] characters ^[a-zA-Z0-9]+$
Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.


 
network
string (card_brand)   [ 1 .. 255 ] characters ^[A-Z_]+$
Name of the card network through which the transaction was routed.


 Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
{
  • "id": "stringstr",
  • "date": "stri",
  • "acquirer_reference_number": "string",
  • "network": "VISA"
}
network_transaction_reference
Reference values used by the card network to identify a transaction.


id
required
string  [ 9 .. 36 ] characters ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$
Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -.


 
date
string  = 4 characters ^[0-9]+$
The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date.


 
acquirer_reference_number
string  [ 1 .. 36 ] characters ^[a-zA-Z0-9]+$
Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.


 
network
string (card_brand)   [ 1 .. 255 ] characters ^[A-Z_]+$
Name of the card network through which the transaction was routed.


 Enum Value Description
VISA
Visa card.


MASTERCARD
Mastercard card.


DISCOVER
Discover card.


AMEX
American Express card.


SOLO
Solo debit card.


JCB
Japan Credit Bureau card.


STAR
Military Star card.


DELTA
Delta Airlines card.


SWITCH
Switch credit card.


MAESTRO
Maestro credit card.


CB_NATIONALE
Carte Bancaire (CB) credit card.


CONFIGOGA
Configoga credit card.


CONFIDIS
Confidis credit card.


ELECTRON
Visa Electron credit card.


CETELEM
Cetelem credit card.


CHINA_UNION_PAY
China union pay credit card.


DINERS
The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.


ELO
The Brazilian Elo card payment network.


HIPER
The Hiper - Ingenico ePayment network.


HIPERCARD
The Brazilian Hipercard payment network that's widely accepted in the retail market.


RUPAY
The RuPay payment network.


GE
The GE Credit Union 3Point card payment network.


SYNCHRONY
The Synchrony Financial (SYF) payment network.


EFTPOS
The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.


UNKNOWN
UNKNOWN payment network.


 
{
  • "id": "stringstr",
  • "date": "stri",
  • "acquirer_reference_number": "string",
  • "network": "VISA"
}
Order
The order details.


create_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction occurred, in Internet date and time format.


 
update_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction was last updated, in Internet date and time format.


 
id
string
The ID of the order.


 
Array of objects (Purchase Unit)   [ 1 .. 10 ] items 
An array of purchase units. Each purchase unit establishes a contract between a customer and merchant. Each purchase unit represents either a full or partial order that the customer intends to purchase from the merchant.


 
Array of objects (Link Description) 
An array of request-related HATEOAS links. To complete payer approval, use the approve link to redirect the payer. The API caller has 6 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 6 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include application_context.return_url is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.


 
object (payment_source_response) 
The payment source used to fund the payment.


 
intent
string (checkout_payment_intent) 
The intent to either capture payment immediately or authorize a payment for an order after order creation.


 Enum Value Description
CAPTURE
The merchant intends to capture payment immediately after the customer makes a payment.


AUTHORIZE
The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one purchase_unit within your order.


 
object <payer_v1>  (payer) 
The customer who approves and pays for the order. The customer is also known as the payer.


 
status
string (Order Status)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The order status.


 Enum Value Description
CREATED
The order was created with the specified context.


SAVED
The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order.


APPROVED
The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on.


VOIDED
All purchase units in the order are voided.


COMPLETED
The intent of the order was completed and a payments resource was created. Important: Check the payment status in purchase_units[].payments.captures[].status before fulfilling the order. A completed order can indicate a payment was authorized, an authorized payment was captured, or a payment was declined.


PAYER_ACTION_REQUIRED
The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order. Some payment sources may not return a payer-action HATEOAS link (eg. MB WAY). For these payment sources the payer-action is managed by the scheme itself (eg. through SMS, email, in-app notification, etc).


 
{
  • "create_time": "string",
  • "update_time": "string",
  • "id": "string",
  • "purchase_units": [
    • {
      • "reference_id": "string",
      • "description": "string",
      • "custom_id": "string",
      • "invoice_id": "string",
      • "id": "string",
      • "soft_descriptor": "string",
      • "items": [
        • {
          • "name": "string",
          • "quantity": "string",
          • "description": "string",
          • "sku": "string",
          • "url": "http://example.com",
          • "category": "DIGITAL_GOODS",
          • "image_url": "http://example.com",
          • "unit_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "upc": {
            • "type": "UPC-A",
            • "code": "string"
            },
          • "billing_plan": {
            • "billing_cycles": [
              • {
                • "tenure_type": null,
                • "total_cycles": null,
                • "sequence": null,
                • "pricing_scheme": null,
                • "start_date": null
                }
              ],
            • "name": "string",
            • "setup_fee": {
              • "currency_code": "str",
              • "value": "string"
              }
            }
          }
        ],
      • "most_recent_errors": [
        • null
        ],
      • "amount": {
        • "currency_code": "str",
        • "value": "string",
        • "breakdown": {
          • "item_total": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "shipping": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "handling": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax_total": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "insurance": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "shipping_discount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "discount": {
            • "currency_code": "str",
            • "value": "string"
            }
          }
        },
      • "payee": {
        • "email_address": "string",
        • "merchant_id": "string"
        },
      • "payment_instruction": {
        • "platform_fees": [
          • {
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "payee": {
              • "email_address": "string",
              • "merchant_id": "string"
              }
            }
          ],
        • "payee_pricing_tier_id": "string",
        • "payee_receivable_fx_rate_id": "string",
        • "disbursement_mode": "INSTANT"
        },
      • "shipping": {
        • "type": "SHIPPING",
        • "options": [
          • {
            • "id": "string",
            • "label": "string",
            • "selected": true,
            • "type": "SHIPPING",
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              }
            }
          ],
        • "name": {
          • "full_name": "string"
          },
        • "email_address": "string",
        • "phone_number": {
          • "country_code": "str",
          • "national_number": "string"
          },
        • "address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          },
        • "trackers": [
          • {
            • "id": "string",
            • "status": "CANCELLED",
            • "items": [
              • {
                • "name": null,
                • "quantity": null,
                • "sku": null,
                • "url": null,
                • "image_url": null,
                • "upc": null
                }
              ],
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null
                }
              ],
            • "create_time": "string",
            • "update_time": "string"
            }
          ]
        },
      • "supplementary_data": {
        • "card": {
          • "level_2": {
            • "invoice_id": "string",
            • "tax_total": {
              • "currency_code": "str",
              • "value": "string"
              }
            },
          • "level_3": {
            • "ships_from_postal_code": "string",
            • "line_items": [
              • {
                • "name": null,
                • "quantity": null,
                • "description": null,
                • "sku": null,
                • "url": null,
                • "image_url": null,
                • "upc": null,
                • "billing_plan": null,
                • "commodity_code": null,
                • "unit_of_measure": null,
                • "unit_amount": null,
                • "tax": null,
                • "discount_amount": null,
                • "total_amount": null
                }
              ],
            • "shipping_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "duty_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "discount_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "shipping_address": {
              • "address_line_1": "string",
              • "address_line_2": "string",
              • "admin_area_2": "string",
              • "admin_area_1": "string",
              • "postal_code": "string",
              • "country_code": "st"
              }
            }
          },
        • "risk": {
          • "customer": {
            • "ip_address": "string"
            }
          }
        },
      • "payments": {
        • "authorizations": [
          • {
            • "status": "CREATED",
            • "status_details": {
              • "reason": "PENDING_REVIEW"
              },
            • "id": "string",
            • "invoice_id": "string",
            • "custom_id": "string",
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null
                }
              ],
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "network_transaction_reference": {
              • "id": "stringstr",
              • "date": "stri",
              • "acquirer_reference_number": "string",
              • "network": "VISA"
              },
            • "seller_protection": {
              • "status": "ELIGIBLE",
              • "dispute_categories": [
                • null
                ]
              },
            • "expiration_time": "string",
            • "create_time": "string",
            • "update_time": "string",
            • "processor_response": {
              • "avs_code": "A",
              • "cvv_code": "E",
              • "response_code": "0000",
              • "payment_advice_code": "01"
              }
            }
          ],
        • "captures": [
          • {
            • "create_time": "string",
            • "update_time": "string",
            • "id": "string",
            • "invoice_id": "string",
            • "custom_id": "string",
            • "final_capture": false,
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null
                }
              ],
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "network_transaction_reference": {
              • "id": "stringstr",
              • "date": "stri",
              • "acquirer_reference_number": "string",
              • "network": "VISA"
              },
            • "seller_protection": {
              • "status": "ELIGIBLE",
              • "dispute_categories": [
                • null
                ]
              },
            • "seller_receivable_breakdown": {
              • "platform_fees": [
                • null
                ],
              • "gross_amount": {
                • "currency_code": null,
                • "value": null
                },
              • "paypal_fee": {
                • "currency_code": null,
                • "value": null
                },
              • "paypal_fee_in_receivable_currency": {
                • "currency_code": null,
                • "value": null
                },
              • "net_amount": {
                • "currency_code": null,
                • "value": null
                },
              • "receivable_amount": {
                • "currency_code": null,
                • "value": null
                },
              • "exchange_rate": {
                • "value": null,
                • "source_currency": null,
                • "target_currency": null
                }
              },
            • "disbursement_mode": "INSTANT",
            • "processor_response": {
              • "avs_code": "A",
              • "cvv_code": "E",
              • "response_code": "0000",
              • "payment_advice_code": "01"
              }
            }
          ],
        • "refunds": [
          • {
            • "status": "CANCELLED",
            • "status_details": {
              • "reason": "ECHECK"
              },
            • "id": "string",
            • "invoice_id": "string",
            • "custom_id": "string",
            • "acquirer_reference_number": "string",
            • "note_to_payer": "string",
            • "seller_payable_breakdown": {
              • "platform_fees": [
                • null
                ],
              • "net_amount_breakdown": [
                • null
                ],
              • "gross_amount": {
                • "currency_code": null,
                • "value": null
                },
              • "paypal_fee": {
                • "currency_code": null,
                • "value": null
                },
              • "paypal_fee_in_receivable_currency": {
                • "currency_code": null,
                • "value": null
                },
              • "net_amount": {
                • "currency_code": null,
                • "value": null
                },
              • "net_amount_in_receivable_currency": {
                • "currency_code": null,
                • "value": null
                },
              • "total_refunded_amount": {
                • "currency_code": null,
                • "value": null
                }
              },
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null
                }
              ],
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "payer": {
              • "email_address": "string",
              • "merchant_id": "string"
              },
            • "create_time": "string",
            • "update_time": "string"
            }
          ]
        }
      }
    ],
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ],
  • "payment_source": {
    • "card": {
      • "name": "string",
      • "last_digits": "string",
      • "available_networks": [
        • "VISA"
        ],
      • "from_request": {
        • "last_digits": "stri",
        • "expiry": "string"
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "brand": "VISA",
      • "type": "CREDIT",
      • "authentication_result": {
        • "liability_shift": "NO",
        • "three_d_secure": {
          • "authentication_status": "Y",
          • "enrollment_status": "Y"
          }
        },
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "links": [
            • {
              • "href": "string",
              • "rel": "string",
              • "method": "GET"
              }
            ],
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "given_name": "string",
              • "surname": "string"
              },
            • "merchant_customer_id": "string"
            }
          }
        },
      • "expiry": "string",
      • "bin_details": {
        • "bin": "string",
        • "issuing_bank": "string",
        • "products": [
          • "string"
          ],
        • "bin_country_code": "string"
        }
      },
    • "bancontact": {
      • "card_last_digits": "stri",
      • "name": "string",
      • "country_code": "string",
      • "bic": "string",
      • "iban_last_chars": "string"
      },
    • "blik": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "one_click": {
        • "consumer_reference": "string"
        }
      },
    • "eps": {
      • "name": "string",
      • "country_code": "string",
      • "bic": "string"
      },
    • "giropay": {
      • "name": "string",
      • "country_code": "string",
      • "bic": "string"
      },
    • "ideal": {
      • "name": "string",
      • "country_code": "string",
      • "bic": "string",
      • "iban_last_chars": "string"
      },
    • "mybank": {
      • "name": "string",
      • "country_code": "string",
      • "bic": "string",
      • "iban_last_chars": "string"
      },
    • "p24": {
      • "payment_descriptor": "string",
      • "method_id": "string",
      • "method_description": "string",
      • "name": "string",
      • "email": "string",
      • "country_code": "string"
      },
    • "sofort": {
      • "name": "string",
      • "country_code": "string",
      • "bic": "string",
      • "iban_last_chars": "string"
      },
    • "trustly": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "bic": "string",
      • "iban_last_chars": "string"
      },
    • "venmo": {
      • "user_name": "string",
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "links": [
            • {
              • "href": "string",
              • "rel": "string",
              • "method": "GET"
              }
            ],
          • "customer": {
            • "id": "string",
            • "name": {
              • "given_name": "string",
              • "surname": "string"
              }
            }
          }
        },
      • "email_address": "string",
      • "account_id": "stringstrings",
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        },
      • "phone_number": {
        • "national_number": "string"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        }
      },
    • "paypal": {
      • "account_status": "VERIFIED",
      • "phone_type": "FAX",
      • "business_name": "string",
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "links": [
            • {
              • "href": "string",
              • "rel": "string",
              • "method": "GET"
              }
            ],
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "given_name": "string",
              • "surname": "string"
              },
            • "merchant_customer_id": "string"
            }
          },
        • "cobranded_cards": [
          • {
            • "labels": [
              • "string"
              ],
            • "payee": {
              • "email_address": "string",
              • "merchant_id": "string"
              },
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              }
            }
          ]
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "charge_pattern": "IMMEDIATE",
        • "usage_pattern": "IMMEDIATE",
        • "usage": "FIRST"
        },
      • "email_address": "string",
      • "account_id": "stringstrings",
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        },
      • "phone_number": {
        • "national_number": "string"
        },
      • "birth_date": "stringstri",
      • "tax_info": {
        • "tax_id": "string",
        • "tax_id_type": "BR_CPF"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        }
      },
    • "apple_pay": {
      • "id": "string",
      • "token": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "national_number": "string"
        },
      • "card": {
        • "name": "string",
        • "last_digits": "string",
        • "available_networks": [
          • "VISA"
          ],
        • "from_request": {
          • "last_digits": "stri",
          • "expiry": "string"
          },
        • "stored_credential": {
          • "payment_initiator": "CUSTOMER",
          • "payment_type": "ONE_TIME",
          • "usage": "FIRST",
          • "previous_network_transaction_reference": {
            • "id": "stringstr",
            • "date": "stri",
            • "acquirer_reference_number": "string",
            • "network": "VISA"
            }
          },
        • "brand": "VISA",
        • "type": "CREDIT",
        • "authentication_result": {
          • "liability_shift": "NO",
          • "three_d_secure": {
            • "authentication_status": "Y",
            • "enrollment_status": "Y"
            }
          },
        • "attributes": {
          • "vault": {
            • "id": "string",
            • "status": "VAULTED",
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null
                }
              ],
            • "customer": {
              • "id": "string",
              • "email_address": "string",
              • "phone": {
                • "phone_type": null,
                • "phone_number": null
                },
              • "name": {
                • "given_name": null,
                • "surname": null
                },
              • "merchant_customer_id": "string"
              }
            }
          },
        • "expiry": "string",
        • "bin_details": {
          • "bin": "string",
          • "issuing_bank": "string",
          • "products": [
            • "string"
            ],
          • "bin_country_code": "string"
          },
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          },
        • "country_code": "string"
        },
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "links": [
            • {
              • "href": "string",
              • "rel": "string",
              • "method": "GET"
              }
            ],
          • "customer": {
            • "id": "string",
            • "name": {
              • "given_name": "string",
              • "surname": "string"
              }
            }
          }
        }
      },
    • "google_pay": {
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "country_code": "str",
        • "national_number": "string"
        },
      • "card": {
        • "name": "string",
        • "last_digits": "stri",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          },
        • "authentication_result": {
          • "liability_shift": "NO",
          • "three_d_secure": {
            • "authentication_status": "Y",
            • "enrollment_status": "Y"
            }
          }
        }
      }
    },
  • "intent": "CAPTURE",
  • "payer": {
    • "email_address": "string",
    • "payer_id": "string",
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "birth_date": "stringstri",
    • "tax_info": {
      • "tax_id": "string",
      • "tax_id_type": "BR_CPF"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      }
    },
  • "status": "CREATED"
}
Order Authorize Request
The authorization of an order request.


object (payment_source) 
The source of payment for the order, which can be a token or a card. Use this object only if you have not redirected the user after order creation to approve the payment. In such cases, the user-selected payment method in the PayPal flow is implicitly used.


 
{
  • "payment_source": {
    • "card": {
      • "name": "string",
      • "number": "stringstrings",
      • "security_code": "stri",
      • "expiry": "string",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          },
        • "verification": {
          • "method": "SCA_ALWAYS"
          }
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "vault_id": "string",
      • "single_use_token": "string",
      • "network_token": {
        • "number": "stringstrings",
        • "cryptogram": "stringstringstringstringstri",
        • "token_requestor_id": "string",
        • "expiry": "string",
        • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION"
        },
      • "experience_context": {
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "token": {
      • "id": "string",
      • "type": "BILLING_AGREEMENT"
      },
    • "paypal": {
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "contact_preference": "NO_CONTACT_INFO",
        • "landing_page": "LOGIN",
        • "user_action": "CONTINUE",
        • "payment_method_preference": "UNRESTRICTED",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string",
        • "order_update_callback_config": {}
        },
      • "billing_agreement_id": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "charge_pattern": "IMMEDIATE",
        • "usage_pattern": "IMMEDIATE",
        • "usage": "FIRST"
        },
      • "vault_id": "string",
      • "email_address": "string",
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        },
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "birth_date": "stringstri",
      • "tax_info": {
        • "tax_id": "string",
        • "tax_id_type": "BR_CPF"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "string",
          • "usage_type": "string",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        }
      },
    • "apple_pay": {
      • "id": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          }
        },
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "national_number": "string"
        },
      • "decrypted_token": {
        • "device_manufacturer_id": "string",
        • "payment_data_type": "3DSECURE",
        • "transaction_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "tokenized_card": {
          • "name": "string",
          • "number": "stringstrings",
          • "expiry": "string",
          • "card_type": "VISA",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st"
            }
          },
        • "payment_data": {
          • "cryptogram": "string",
          • "eci_indicator": "string",
          • "emv_data": "string",
          • "pin": "string"
          }
        },
      • "vault_id": "string",
      • "experience_context": {
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "google_pay": {
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "country_code": "str",
        • "national_number": "string"
        },
      • "card": {
        • "name": "string",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        },
      • "decrypted_token": {
        • "message_id": "string",
        • "message_expiration": "stringstrings",
        • "payment_method": "CARD",
        • "authentication_method": "PAN_ONLY",
        • "cryptogram": "string",
        • "eci_indicator": "string",
        • "card": {
          • "name": "string",
          • "number": "stringstrings",
          • "last_digits": "stri",
          • "expiry": "string",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st"
            }
          }
        },
      • "assurance_details": {
        • "account_verified": false,
        • "card_holder_authenticated": false
        },
      • "experience_context": {
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "venmo": {
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "order_update_callback_config": {}
        },
      • "vault_id": "string",
      • "email_address": "string",
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "string",
          • "usage_type": "string",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        }
      }
    }
}
Order Authorize Response
The order authorize response.


create_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction occurred, in Internet date and time format.


 
update_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction was last updated, in Internet date and time format.


 
id
string
The ID of the order.


 
Array of objects (Purchase Unit)   [ 1 .. 10 ] items 
An array of purchase units. Each purchase unit establishes a contract between a customer and merchant. Each purchase unit represents either a full or partial order that the customer intends to purchase from the merchant.


 
Array of objects (Link Description) 
An array of request-related HATEOAS links. To complete payer approval, use the approve link to redirect the payer. The API caller has 6 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 6 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include application_context.return_url is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.


 
object (payment_source_response) 
The payment source used to fund the payment.


 
intent
string (checkout_payment_intent) 
The intent to either capture payment immediately or authorize a payment for an order after order creation.


 Enum Value Description
CAPTURE
The merchant intends to capture payment immediately after the customer makes a payment.


AUTHORIZE
The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one purchase_unit within your order.


 
object <payer_v1>  (payer) 
The customer who approves and pays for the order. The customer is also known as the payer.


 
status
string (Order Status)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The order status.


 Enum Value Description
CREATED
The order was created with the specified context.


SAVED
The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order.


APPROVED
The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on.


VOIDED
All purchase units in the order are voided.


COMPLETED
The intent of the order was completed and a payments resource was created. Important: Check the payment status in purchase_units[].payments.captures[].status before fulfilling the order. A completed order can indicate a payment was authorized, an authorized payment was captured, or a payment was declined.


PAYER_ACTION_REQUIRED
The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order. Some payment sources may not return a payer-action HATEOAS link (eg. MB WAY). For these payment sources the payer-action is managed by the scheme itself (eg. through SMS, email, in-app notification, etc).


 
{
  • "create_time": "string",
  • "update_time": "string",
  • "id": "string",
  • "purchase_units": [
    • {
      • "reference_id": "string",
      • "description": "string",
      • "custom_id": "string",
      • "invoice_id": "string",
      • "id": "string",
      • "soft_descriptor": "string",
      • "items": [
        • {
          • "name": "string",
          • "quantity": "string",
          • "description": "string",
          • "sku": "string",
          • "url": "http://example.com",
          • "category": "DIGITAL_GOODS",
          • "image_url": "http://example.com",
          • "unit_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "upc": {
            • "type": "UPC-A",
            • "code": "string"
            },
          • "billing_plan": {
            • "billing_cycles": [
              • {
                • "tenure_type": null,
                • "total_cycles": null,
                • "sequence": null,
                • "pricing_scheme": null,
                • "start_date": null
                }
              ],
            • "name": "string",
            • "setup_fee": {
              • "currency_code": "str",
              • "value": "string"
              }
            }
          }
        ],
      • "most_recent_errors": [
        • null
        ],
      • "amount": {
        • "currency_code": "str",
        • "value": "string",
        • "breakdown": {
          • "item_total": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "shipping": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "handling": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax_total": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "insurance": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "shipping_discount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "discount": {
            • "currency_code": "str",
            • "value": "string"
            }
          }
        },
      • "payee": {
        • "email_address": "string",
        • "merchant_id": "string"
        },
      • "payment_instruction": {
        • "platform_fees": [
          • {
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "payee": {
              • "email_address": "string",
              • "merchant_id": "string"
              }
            }
          ],
        • "payee_pricing_tier_id": "string",
        • "payee_receivable_fx_rate_id": "string",
        • "disbursement_mode": "INSTANT"
        },
      • "shipping": {
        • "type": "SHIPPING",
        • "options": [
          • {
            • "id": "string",
            • "label": "string",
            • "selected": true,
            • "type": "SHIPPING",
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              }
            }
          ],
        • "name": {
          • "full_name": "string"
          },
        • "email_address": "string",
        • "phone_number": {
          • "country_code": "str",
          • "national_number": "string"
          },
        • "address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          },
        • "trackers": [
          • {
            • "id": "string",
            • "status": "CANCELLED",
            • "items": [
              • {
                • "name": null,
                • "quantity": null,
                • "sku": null,
                • "url": null,
                • "image_url": null,
                • "upc": null
                }
              ],
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null
                }
              ],
            • "create_time": "string",
            • "update_time": "string"
            }
          ]
        },
      • "supplementary_data": {
        • "card": {
          • "level_2": {
            • "invoice_id": "string",
            • "tax_total": {
              • "currency_code": "str",
              • "value": "string"
              }
            },
          • "level_3": {
            • "ships_from_postal_code": "string",
            • "line_items": [
              • {
                • "name": null,
                • "quantity": null,
                • "description": null,
                • "sku": null,
                • "url": null,
                • "image_url": null,
                • "upc": null,
                • "billing_plan": null,
                • "commodity_code": null,
                • "unit_of_measure": null,
                • "unit_amount": null,
                • "tax": null,
                • "discount_amount": null,
                • "total_amount": null
                }
              ],
            • "shipping_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "duty_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "discount_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "shipping_address": {
              • "address_line_1": "string",
              • "address_line_2": "string",
              • "admin_area_2": "string",
              • "admin_area_1": "string",
              • "postal_code": "string",
              • "country_code": "st"
              }
            }
          },
        • "risk": {
          • "customer": {
            • "ip_address": "string"
            }
          }
        },
      • "payments": {
        • "authorizations": [
          • {
            • "status": "CREATED",
            • "status_details": {
              • "reason": "PENDING_REVIEW"
              },
            • "id": "string",
            • "invoice_id": "string",
            • "custom_id": "string",
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null
                }
              ],
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "network_transaction_reference": {
              • "id": "stringstr",
              • "date": "stri",
              • "acquirer_reference_number": "string",
              • "network": "VISA"
              },
            • "seller_protection": {
              • "status": "ELIGIBLE",
              • "dispute_categories": [
                • null
                ]
              },
            • "expiration_time": "string",
            • "create_time": "string",
            • "update_time": "string",
            • "processor_response": {
              • "avs_code": "A",
              • "cvv_code": "E",
              • "response_code": "0000",
              • "payment_advice_code": "01"
              }
            }
          ],
        • "captures": [
          • {
            • "create_time": "string",
            • "update_time": "string",
            • "id": "string",
            • "invoice_id": "string",
            • "custom_id": "string",
            • "final_capture": false,
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null
                }
              ],
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "network_transaction_reference": {
              • "id": "stringstr",
              • "date": "stri",
              • "acquirer_reference_number": "string",
              • "network": "VISA"
              },
            • "seller_protection": {
              • "status": "ELIGIBLE",
              • "dispute_categories": [
                • null
                ]
              },
            • "seller_receivable_breakdown": {
              • "platform_fees": [
                • null
                ],
              • "gross_amount": {
                • "currency_code": null,
                • "value": null
                },
              • "paypal_fee": {
                • "currency_code": null,
                • "value": null
                },
              • "paypal_fee_in_receivable_currency": {
                • "currency_code": null,
                • "value": null
                },
              • "net_amount": {
                • "currency_code": null,
                • "value": null
                },
              • "receivable_amount": {
                • "currency_code": null,
                • "value": null
                },
              • "exchange_rate": {
                • "value": null,
                • "source_currency": null,
                • "target_currency": null
                }
              },
            • "disbursement_mode": "INSTANT",
            • "processor_response": {
              • "avs_code": "A",
              • "cvv_code": "E",
              • "response_code": "0000",
              • "payment_advice_code": "01"
              }
            }
          ],
        • "refunds": [
          • {
            • "status": "CANCELLED",
            • "status_details": {
              • "reason": "ECHECK"
              },
            • "id": "string",
            • "invoice_id": "string",
            • "custom_id": "string",
            • "acquirer_reference_number": "string",
            • "note_to_payer": "string",
            • "seller_payable_breakdown": {
              • "platform_fees": [
                • null
                ],
              • "net_amount_breakdown": [
                • null
                ],
              • "gross_amount": {
                • "currency_code": null,
                • "value": null
                },
              • "paypal_fee": {
                • "currency_code": null,
                • "value": null
                },
              • "paypal_fee_in_receivable_currency": {
                • "currency_code": null,
                • "value": null
                },
              • "net_amount": {
                • "currency_code": null,
                • "value": null
                },
              • "net_amount_in_receivable_currency": {
                • "currency_code": null,
                • "value": null
                },
              • "total_refunded_amount": {
                • "currency_code": null,
                • "value": null
                }
              },
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null
                }
              ],
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "payer": {
              • "email_address": "string",
              • "merchant_id": "string"
              },
            • "create_time": "string",
            • "update_time": "string"
            }
          ]
        }
      }
    ],
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ],
  • "payment_source": {
    • "card": {
      • "name": "string",
      • "last_digits": "string",
      • "available_networks": [
        • "VISA"
        ],
      • "from_request": {
        • "last_digits": "stri",
        • "expiry": "string"
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "brand": "VISA",
      • "type": "CREDIT",
      • "authentication_result": {
        • "liability_shift": "NO",
        • "three_d_secure": {
          • "authentication_status": "Y",
          • "enrollment_status": "Y"
          }
        },
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "links": [
            • {
              • "href": "string",
              • "rel": "string",
              • "method": "GET"
              }
            ],
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "given_name": "string",
              • "surname": "string"
              },
            • "merchant_customer_id": "string"
            }
          }
        },
      • "expiry": "string",
      • "bin_details": {
        • "bin": "string",
        • "issuing_bank": "string",
        • "products": [
          • "string"
          ],
        • "bin_country_code": "string"
        }
      },
    • "venmo": {
      • "user_name": "string",
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "links": [
            • {
              • "href": "string",
              • "rel": "string",
              • "method": "GET"
              }
            ],
          • "customer": {
            • "id": "string",
            • "name": {
              • "given_name": "string",
              • "surname": "string"
              }
            }
          }
        },
      • "email_address": "string",
      • "account_id": "stringstrings",
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        },
      • "phone_number": {
        • "national_number": "string"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        }
      },
    • "paypal": {
      • "account_status": "VERIFIED",
      • "phone_type": "FAX",
      • "business_name": "string",
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "links": [
            • {
              • "href": "string",
              • "rel": "string",
              • "method": "GET"
              }
            ],
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "given_name": "string",
              • "surname": "string"
              },
            • "merchant_customer_id": "string"
            }
          },
        • "cobranded_cards": [
          • {
            • "labels": [
              • "string"
              ],
            • "payee": {
              • "email_address": "string",
              • "merchant_id": "string"
              },
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              }
            }
          ]
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "charge_pattern": "IMMEDIATE",
        • "usage_pattern": "IMMEDIATE",
        • "usage": "FIRST"
        },
      • "email_address": "string",
      • "account_id": "stringstrings",
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        },
      • "phone_number": {
        • "national_number": "string"
        },
      • "birth_date": "stringstri",
      • "tax_info": {
        • "tax_id": "string",
        • "tax_id_type": "BR_CPF"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        }
      },
    • "apple_pay": {
      • "id": "string",
      • "token": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "national_number": "string"
        },
      • "card": {
        • "name": "string",
        • "last_digits": "string",
        • "available_networks": [
          • "VISA"
          ],
        • "from_request": {
          • "last_digits": "stri",
          • "expiry": "string"
          },
        • "stored_credential": {
          • "payment_initiator": "CUSTOMER",
          • "payment_type": "ONE_TIME",
          • "usage": "FIRST",
          • "previous_network_transaction_reference": {
            • "id": "stringstr",
            • "date": "stri",
            • "acquirer_reference_number": "string",
            • "network": "VISA"
            }
          },
        • "brand": "VISA",
        • "type": "CREDIT",
        • "authentication_result": {
          • "liability_shift": "NO",
          • "three_d_secure": {
            • "authentication_status": "Y",
            • "enrollment_status": "Y"
            }
          },
        • "attributes": {
          • "vault": {
            • "id": "string",
            • "status": "VAULTED",
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null
                }
              ],
            • "customer": {
              • "id": "string",
              • "email_address": "string",
              • "phone": {
                • "phone_type": null,
                • "phone_number": null
                },
              • "name": {
                • "given_name": null,
                • "surname": null
                },
              • "merchant_customer_id": "string"
              }
            }
          },
        • "expiry": "string",
        • "bin_details": {
          • "bin": "string",
          • "issuing_bank": "string",
          • "products": [
            • "string"
            ],
          • "bin_country_code": "string"
          },
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          },
        • "country_code": "string"
        },
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "links": [
            • {
              • "href": "string",
              • "rel": "string",
              • "method": "GET"
              }
            ],
          • "customer": {
            • "id": "string",
            • "name": {
              • "given_name": "string",
              • "surname": "string"
              }
            }
          }
        }
      },
    • "google_pay": {
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "country_code": "str",
        • "national_number": "string"
        },
      • "card": {
        • "name": "string",
        • "last_digits": "stri",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          },
        • "authentication_result": {
          • "liability_shift": "NO",
          • "three_d_secure": {
            • "authentication_status": "Y",
            • "enrollment_status": "Y"
            }
          }
        }
      }
    },
  • "intent": "CAPTURE",
  • "payer": {
    • "email_address": "string",
    • "payer_id": "string",
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "birth_date": "stringstri",
    • "tax_info": {
      • "tax_id": "string",
      • "tax_id_type": "BR_CPF"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      }
    },
  • "status": "CREATED"
}
Order Capture Request
Completes an capture payment for an order.


object (payment_source) 
The payment source definition.


 
{
  • "payment_source": {
    • "card": {
      • "name": "string",
      • "number": "stringstrings",
      • "security_code": "stri",
      • "expiry": "string",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          },
        • "verification": {
          • "method": "SCA_ALWAYS"
          }
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "vault_id": "string",
      • "single_use_token": "string",
      • "network_token": {
        • "number": "stringstrings",
        • "cryptogram": "stringstringstringstringstri",
        • "token_requestor_id": "string",
        • "expiry": "string",
        • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION"
        },
      • "experience_context": {
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "token": {
      • "id": "string",
      • "type": "BILLING_AGREEMENT"
      },
    • "paypal": {
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "contact_preference": "NO_CONTACT_INFO",
        • "landing_page": "LOGIN",
        • "user_action": "CONTINUE",
        • "payment_method_preference": "UNRESTRICTED",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string",
        • "order_update_callback_config": {}
        },
      • "billing_agreement_id": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "charge_pattern": "IMMEDIATE",
        • "usage_pattern": "IMMEDIATE",
        • "usage": "FIRST"
        },
      • "vault_id": "string",
      • "email_address": "string",
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        },
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "birth_date": "stringstri",
      • "tax_info": {
        • "tax_id": "string",
        • "tax_id_type": "BR_CPF"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "string",
          • "usage_type": "string",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        }
      },
    • "apple_pay": {
      • "id": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          }
        },
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "national_number": "string"
        },
      • "decrypted_token": {
        • "device_manufacturer_id": "string",
        • "payment_data_type": "3DSECURE",
        • "transaction_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "tokenized_card": {
          • "name": "string",
          • "number": "stringstrings",
          • "expiry": "string",
          • "card_type": "VISA",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st"
            }
          },
        • "payment_data": {
          • "cryptogram": "string",
          • "eci_indicator": "string",
          • "emv_data": "string",
          • "pin": "string"
          }
        },
      • "vault_id": "string",
      • "experience_context": {
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "google_pay": {
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "country_code": "str",
        • "national_number": "string"
        },
      • "card": {
        • "name": "string",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        },
      • "decrypted_token": {
        • "message_id": "string",
        • "message_expiration": "stringstrings",
        • "payment_method": "CARD",
        • "authentication_method": "PAN_ONLY",
        • "cryptogram": "string",
        • "eci_indicator": "string",
        • "card": {
          • "name": "string",
          • "number": "stringstrings",
          • "last_digits": "stri",
          • "expiry": "string",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st"
            }
          }
        },
      • "assurance_details": {
        • "account_verified": false,
        • "card_holder_authenticated": false
        },
      • "experience_context": {
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "venmo": {
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "order_update_callback_config": {}
        },
      • "vault_id": "string",
      • "email_address": "string",
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "string",
          • "usage_type": "string",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        }
      }
    }
}
Order Confirm Application Context
Customizes the payer confirmation experience.


brand_name
string  [ 1 .. 127 ] characters 
Label to present to your payer as part of the PayPal hosted web experience.


 
return_url
string <uri>   [ 10 .. 4000 ] characters 
The URL where the customer is redirected after the customer approves the payment.


 
cancel_url
string <uri>   [ 10 .. 4000 ] characters 
The URL where the customer is redirected after the customer cancels the payment.


 
locale
string <ppaas_common_language_v3>  (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.


 
object (stored_payment_source) 
Provides additional details to process a payment using a payment_source that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
  • payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
  • usage=FIRST is compatible only with payment_initiator=CUSTOMER.
  • previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
  • Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.


 
{
  • "brand_name": "string",
  • "return_url": "http://example.com",
  • "cancel_url": "http://example.com",
  • "locale": "string",
  • "stored_payment_source": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "acquirer_reference_number": "string",
      • "network": "VISA"
      }
    }
}
Order Request
The order request details.


required
Array of objects (Purchase Unit Request)   [ 1 .. 10 ] items 
An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.


 
intent
required
string (checkout_payment_intent) 
The intent to either capture payment immediately or authorize a payment for an order after order creation.


 Enum Value Description
CAPTURE
The merchant intends to capture payment immediately after the customer makes a payment.


AUTHORIZE
The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one purchase_unit within your order.


 
object <payer_v1>  (payer) 
DEPRECATED. The customer is also known as the payer. The Payer object was intended to only be used with the payment_source.paypal object. In order to make this design more clear, the details in the payer object are now available under payment_source.paypal. Please use payment_source.paypal.


 
object (payment_source) 
The payment source definition.


 
object (application_context) 
Customize the payer experience during the approval process for the payment with PayPal.


 
{
  • "purchase_units": [
    • {
      • "reference_id": "string",
      • "description": "string",
      • "custom_id": "string",
      • "invoice_id": "string",
      • "soft_descriptor": "string",
      • "items": [
        • {
          • "name": "string",
          • "quantity": "string",
          • "description": "string",
          • "sku": "string",
          • "url": "http://example.com",
          • "category": "DIGITAL_GOODS",
          • "image_url": "http://example.com",
          • "unit_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "upc": {
            • "type": "UPC-A",
            • "code": "string"
            },
          • "billing_plan": {
            • "billing_cycles": [
              • {
                • "tenure_type": null,
                • "total_cycles": null,
                • "sequence": null,
                • "pricing_scheme": null,
                • "start_date": null
                }
              ],
            • "name": "string",
            • "setup_fee": {
              • "currency_code": "str",
              • "value": "string"
              }
            }
          }
        ],
      • "amount": {
        • "currency_code": "str",
        • "value": "string",
        • "breakdown": {
          • "item_total": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "shipping": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "handling": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax_total": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "insurance": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "shipping_discount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "discount": {
            • "currency_code": "str",
            • "value": "string"
            }
          }
        },
      • "payee": {
        • "email_address": "string",
        • "merchant_id": "string"
        },
      • "payment_instruction": {
        • "platform_fees": [
          • {
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "payee": {
              • "email_address": "string",
              • "merchant_id": "string"
              }
            }
          ],
        • "payee_pricing_tier_id": "string",
        • "payee_receivable_fx_rate_id": "string",
        • "disbursement_mode": "INSTANT"
        },
      • "shipping": {
        • "type": "SHIPPING",
        • "options": [
          • {
            • "id": "string",
            • "label": "string",
            • "selected": true,
            • "type": "SHIPPING",
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              }
            }
          ],
        • "name": {
          • "full_name": "string"
          },
        • "email_address": "string",
        • "phone_number": {
          • "country_code": "str",
          • "national_number": "string"
          },
        • "address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        },
      • "supplementary_data": {
        • "card": {
          • "level_2": {
            • "invoice_id": "string",
            • "tax_total": {
              • "currency_code": "str",
              • "value": "string"
              }
            },
          • "level_3": {
            • "ships_from_postal_code": "string",
            • "line_items": [
              • {
                • "name": null,
                • "quantity": null,
                • "description": null,
                • "sku": null,
                • "url": null,
                • "image_url": null,
                • "upc": null,
                • "billing_plan": null,
                • "commodity_code": null,
                • "unit_of_measure": null,
                • "unit_amount": null,
                • "tax": null,
                • "discount_amount": null,
                • "total_amount": null
                }
              ],
            • "shipping_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "duty_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "discount_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "shipping_address": {
              • "address_line_1": "string",
              • "address_line_2": "string",
              • "admin_area_2": "string",
              • "admin_area_1": "string",
              • "postal_code": "string",
              • "country_code": "st"
              }
            }
          },
        • "risk": {
          • "customer": {
            • "ip_address": "string"
            }
          }
        }
      }
    ],
  • "intent": "CAPTURE",
  • "payer": {
    • "email_address": "string",
    • "payer_id": "string",
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "birth_date": "stringstri",
    • "tax_info": {
      • "tax_id": "string",
      • "tax_id_type": "BR_CPF"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      }
    },
  • "payment_source": {
    • "card": {
      • "name": "string",
      • "number": "stringstrings",
      • "security_code": "stri",
      • "expiry": "string",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          },
        • "verification": {
          • "method": "SCA_ALWAYS"
          }
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "vault_id": "string",
      • "single_use_token": "string",
      • "network_token": {
        • "number": "stringstrings",
        • "cryptogram": "stringstringstringstringstri",
        • "token_requestor_id": "string",
        • "expiry": "string",
        • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION"
        },
      • "experience_context": {
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "token": {
      • "id": "string",
      • "type": "BILLING_AGREEMENT"
      },
    • "paypal": {
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "contact_preference": "NO_CONTACT_INFO",
        • "landing_page": "LOGIN",
        • "user_action": "CONTINUE",
        • "payment_method_preference": "UNRESTRICTED",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string",
        • "order_update_callback_config": {}
        },
      • "billing_agreement_id": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "charge_pattern": "IMMEDIATE",
        • "usage_pattern": "IMMEDIATE",
        • "usage": "FIRST"
        },
      • "vault_id": "string",
      • "email_address": "string",
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        },
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "birth_date": "stringstri",
      • "tax_info": {
        • "tax_id": "string",
        • "tax_id_type": "BR_CPF"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "string",
          • "usage_type": "string",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        }
      },
    • "bancontact": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "blik": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string",
        • "consumer_user_agent": "string",
        • "consumer_ip": "string"
        },
      • "level_0": {
        • "auth_code": "string"
        },
      • "one_click": {
        • "auth_code": "string",
        • "consumer_reference": "string",
        • "alias_label": "stringst",
        • "alias_key": "string"
        }
      },
    • "eps": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "giropay": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "ideal": {
      • "name": "string",
      • "country_code": "string",
      • "bic": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "mybank": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "p24": {
      • "name": "string",
      • "email": "string",
      • "country_code": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "sofort": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "trustly": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "locale": "string",
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "apple_pay": {
      • "id": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          }
        },
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "national_number": "string"
        },
      • "decrypted_token": {
        • "device_manufacturer_id": "string",
        • "payment_data_type": "3DSECURE",
        • "transaction_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "tokenized_card": {
          • "name": "string",
          • "number": "stringstrings",
          • "expiry": "string",
          • "card_type": "VISA",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st"
            }
          },
        • "payment_data": {
          • "cryptogram": "string",
          • "eci_indicator": "string",
          • "emv_data": "string",
          • "pin": "string"
          }
        },
      • "vault_id": "string",
      • "experience_context": {
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "google_pay": {
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "country_code": "str",
        • "national_number": "string"
        },
      • "card": {
        • "name": "string",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        },
      • "decrypted_token": {
        • "message_id": "string",
        • "message_expiration": "stringstrings",
        • "payment_method": "CARD",
        • "authentication_method": "PAN_ONLY",
        • "cryptogram": "string",
        • "eci_indicator": "string",
        • "card": {
          • "name": "string",
          • "number": "stringstrings",
          • "last_digits": "stri",
          • "expiry": "string",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st"
            }
          }
        },
      • "assurance_details": {
        • "account_verified": false,
        • "card_holder_authenticated": false
        },
      • "experience_context": {
        • "return_url": "string",
        • "cancel_url": "string"
        }
      },
    • "venmo": {
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "order_update_callback_config": {}
        },
      • "vault_id": "string",
      • "email_address": "string",
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "string",
          • "usage_type": "string",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        }
      }
    },
  • "application_context": {
    • "brand_name": "string",
    • "landing_page": "LOGIN",
    • "shipping_preference": "GET_FROM_FILE",
    • "user_action": "CONTINUE",
    • "return_url": "http://example.com",
    • "cancel_url": "http://example.com",
    • "locale": "string",
    • "payment_method": {
      • "standard_entry_class_code": "TEL",
      • "payee_preferred": "UNRESTRICTED"
      },
    • "stored_payment_source": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        }
      }
    }
}
Order Status
The order status.


string (Order Status)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The order status.


 Enum Value Description
CREATED
The order was created with the specified context.


SAVED
The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order.


APPROVED
The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on.


VOIDED
All purchase units in the order are voided.


COMPLETED
The intent of the order was completed and a payments resource was created. Important: Check the payment status in purchase_units[].payments.captures[].status before fulfilling the order. A completed order can indicate a payment was authorized, an authorized payment was captured, or a payment was declined.


PAYER_ACTION_REQUIRED
The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order. Some payment sources may not return a payer-action HATEOAS link (eg. MB WAY). For these payment sources the payer-action is managed by the scheme itself (eg. through SMS, email, in-app notification, etc).


 
"CREATED"
order_billing_plan
Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.


required
Array of objects (billing_cycle)   [ 1 .. 3 ] items 
An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle.


 
name
string  [ 1 .. 127 ] characters ^[A-Za-z0-9() +',.:-]+$
Name of the recurring plan.


 
object (Money) 
The setup fee for the recurring plan. Ensure its part of the item amount.


 
{
  • "billing_cycles": [
    • {
      • "tenure_type": "REGULAR",
      • "total_cycles": 1,
      • "sequence": 1,
      • "pricing_scheme": {
        • "pricing_model": "FIXED",
        • "price": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "reload_threshold_amount": {
          • "currency_code": "str",
          • "value": "string"
          }
        },
      • "start_date": "string"
      }
    ],
  • "name": "string",
  • "setup_fee": {
    • "currency_code": "str",
    • "value": "string"
    }
}
OrderUpdateCallbackErrorResponse
The error details.


name
required
string  [ 1 .. 256 ] characters ^.*$
The human-readable, unique name of the error.


 
message
string  [ 1 .. 2048 ] characters ^.*$
The message that describes the error.


 
Array of objects (OrderUpdateCallbackErrorResponseDetails)   [ 1 .. 100 ] items 
An array of additional details about the error.


 
{
  • "name": "string",
  • "message": "string",
  • "details": [
    • {
      • "field": "string",
      • "value": "string",
      • "issue": "string"
      }
    ]
}
OrderUpdateCallbackErrorResponseDetails
The error details. Required for client-side 4XX errors.


field
string  [ 0 .. 256 ] characters ^.*$
The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.


 
value
string  [ 0 .. 1024 ] characters ^.*$
The value of the field that caused the error.


 
issue
required
string  [ 0 .. 256 ] characters ^.*$
The unique, fine-grained application-level error code.


 
{
  • "field": "string",
  • "value": "string",
  • "issue": "string"
}
OrderUpdateCallbackRequest
Shipping Options Callback request. This will be implemented by the merchants.


id
string  [ 1 .. 36 ] characters ^[A-Z0-9-]+$
The ID of the order.


 
required
Array of objects (Purchase Unit Request)   = 1 items 
An array of purchase units. At present only 1 purchase_unit is supported. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.


 
required
object (Portable Postal Address (Medium-Grained)) 
Redacted shipping address to be used for shipping options and tax calculations.


 
object (shipping_option) 
Buyer selected shipping option.


 
{
  • "id": "string",
  • "purchase_units": [
    • {
      • "reference_id": "string",
      • "description": "string",
      • "custom_id": "string",
      • "invoice_id": "string",
      • "soft_descriptor": "string",
      • "items": [
        • {
          • "name": "string",
          • "quantity": "string",
          • "description": "string",
          • "sku": "string",
          • "url": "http://example.com",
          • "category": "DIGITAL_GOODS",
          • "image_url": "http://example.com",
          • "unit_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "upc": {
            • "type": "UPC-A",
            • "code": "string"
            },
          • "billing_plan": {
            • "billing_cycles": [
              • {
                • "tenure_type": null,
                • "total_cycles": null,
                • "sequence": null,
                • "pricing_scheme": null,
                • "start_date": null
                }
              ],
            • "name": "string",
            • "setup_fee": {
              • "currency_code": "str",
              • "value": "string"
              }
            }
          }
        ],
      • "amount": {
        • "currency_code": "str",
        • "value": "string",
        • "breakdown": {
          • "item_total": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "shipping": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "handling": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax_total": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "insurance": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "shipping_discount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "discount": {
            • "currency_code": "str",
            • "value": "string"
            }
          }
        },
      • "payee": {
        • "email_address": "string",
        • "merchant_id": "string"
        },
      • "payment_instruction": {
        • "platform_fees": [
          • {
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "payee": {
              • "email_address": "string",
              • "merchant_id": "string"
              }
            }
          ],
        • "payee_pricing_tier_id": "string",
        • "payee_receivable_fx_rate_id": "string",
        • "disbursement_mode": "INSTANT"
        },
      • "shipping": {
        • "type": "SHIPPING",
        • "options": [
          • {
            • "id": "string",
            • "label": "string",
            • "selected": true,
            • "type": "SHIPPING",
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              }
            }
          ],
        • "name": {
          • "full_name": "string"
          },
        • "email_address": "string",
        • "phone_number": {
          • "country_code": "str",
          • "national_number": "string"
          },
        • "address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        },
      • "supplementary_data": {
        • "card": {
          • "level_2": {
            • "invoice_id": "string",
            • "tax_total": {
              • "currency_code": "str",
              • "value": "string"
              }
            },
          • "level_3": {
            • "ships_from_postal_code": "string",
            • "line_items": [
              • {
                • "name": null,
                • "quantity": null,
                • "description": null,
                • "sku": null,
                • "url": null,
                • "image_url": null,
                • "upc": null,
                • "billing_plan": null,
                • "commodity_code": null,
                • "unit_of_measure": null,
                • "unit_amount": null,
                • "tax": null,
                • "discount_amount": null,
                • "total_amount": null
                }
              ],
            • "shipping_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "duty_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "discount_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "shipping_address": {
              • "address_line_1": "string",
              • "address_line_2": "string",
              • "admin_area_2": "string",
              • "admin_area_1": "string",
              • "postal_code": "string",
              • "country_code": "st"
              }
            }
          },
        • "risk": {
          • "customer": {
            • "ip_address": "string"
            }
          }
        }
      }
    ],
  • "shipping_address": {
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    },
  • "shipping_option": {
    • "id": "string",
    • "label": "string",
    • "type": "SHIPPING",
    • "amount": {
      • "currency_code": "str",
      • "value": "string"
      }
    }
}
OrderUpdateCallbackResponse
Returns the updated shipping options for an order.


id
string  [ 1 .. 36 ] characters ^[A-Z0-9-]+$
The ID of the order.


 
object (Shipping Option and Amount data at Purchase Unit) 
This would contain shipping option and amount data at purchase unit level.


 
{
  • "id": "string",
  • "purchase_units": {
    • "reference_id": "string",
    • "shipping_options": [
      • {
        • "id": "string",
        • "label": "string",
        • "selected": true,
        • "type": "SHIPPING",
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          }
        }
      ],
    • "amount": {
      • "currency_code": "str",
      • "value": "string",
      • "breakdown": {
        • "item_total": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "shipping": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "handling": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "tax_total": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "insurance": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "shipping_discount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "discount": {
          • "currency_code": "str",
          • "value": "string"
          }
        }
      }
    }
}
p24
Information used to pay using P24(Przelewy24).


payment_descriptor
string  [ 1 .. 2000 ] characters 
P24 generated payment description.


 
method_id
string  [ 1 .. 300 ] characters 
Numeric identifier of the payment scheme or bank used for the payment.


 
method_description
string  [ 1 .. 2000 ] characters 
Friendly name of the payment scheme or bank used for the payment.


 
name
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
email
string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The email address of the account holder associated with this payment method.


 
country_code
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
{
  • "payment_descriptor": "string",
  • "method_id": "string",
  • "method_description": "string",
  • "name": "string",
  • "email": "string",
  • "country_code": "string"
}
p24_request
Information needed to pay using P24 (Przelewy24).


name
required
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
email
required
string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The email address of the account holder associated with this payment method.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "email": "string",
  • "country_code": "string",
  • "experience_context": {
    • "brand_name": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "locale": "string",
    • "return_url": "string",
    • "cancel_url": "string"
    }
}
pares_status
Transactions status result identifier. The outcome of the issuer's authentication.


string (pares_status)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Transactions status result identifier. The outcome of the issuer's authentication.


 Enum Value Description
Y
Successful authentication.


N
Failed authentication / account not verified / transaction denied.


U
Unable to complete authentication.


A
Successful attempts transaction.


C
Challenge required for authentication.


R
Authentication rejected (merchant must not submit for authorization).


D
Challenge required; decoupled authentication confirmed.


I
Informational only; 3DS requestor challenge preference acknowledged.


 
"Y"
participant_metadata
Profile information of the sender or receiver.


ip_address
string <ppaas_ip_address_v1>  (IP Address)   [ 7 .. 39 ] characters ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...
The consumer's IP address, which can be represented in either IPv4 or IPv6 format.


 
{
  • "ip_address": "string"
}
Patch
The JSON patch object to apply partial updates to resources.


op
required
string
The operation.


 Enum Value Description
add
Depending on the target location reference, completes one of these functions:
  • The target location is an array index. Inserts a new value into the array at the specified index.
  • The target location is an object parameter that does not already exist. Adds a new parameter to the object.
  • The target location is an object parameter that does exist. Replaces that parameter's value.
The value parameter defines the value to add. For more information, see 4.1. add.


remove
Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.


replace
Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.


move
Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move.


copy
Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy.


test
Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:
TypeConsidered equal if both values
stringsContain the same number of Unicode characters and their code points are byte-by-byte equal.
numbersAre numerically equal.
arraysContain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
objectsContain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
literals (false, true, and null)Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.
For more information, see 4.6. test.


 
path
string
The JSON Pointer to the target document location at which to complete the operation.


 
value
any (Patch Value) 
The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified.


 
from
string
The JSON Pointer to the target document location from which to move the value. Required for the move operation.


 
{
  • "op": "add",
  • "path": "string",
  • "value": null,
  • "from": "string"
}
Patch Request
An array of JSON patch objects to apply partial updates to resources.


 Array ([ 0 .. 32767 ] items)
op
required
string
The operation.


 Enum Value Description
add
Depending on the target location reference, completes one of these functions:
  • The target location is an array index. Inserts a new value into the array at the specified index.
  • The target location is an object parameter that does not already exist. Adds a new parameter to the object.
  • The target location is an object parameter that does exist. Replaces that parameter's value.
The value parameter defines the value to add. For more information, see 4.1. add.


remove
Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.


replace
Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.


move
Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move.


copy
Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy.


test
Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:
TypeConsidered equal if both values
stringsContain the same number of Unicode characters and their code points are byte-by-byte equal.
numbersAre numerically equal.
arraysContain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
objectsContain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
literals (false, true, and null)Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.
For more information, see 4.6. test.


 
path
string
The JSON Pointer to the target document location at which to complete the operation.


 
value
any (Patch Value) 
The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified.


 
from
string
The JSON Pointer to the target document location from which to move the value. Required for the move operation.


 
[
  • {
    • "op": "add",
    • "path": "string",
    • "value": null,
    • "from": "string"
    }
]
payee
The merchant who receives the funds and fulfills the order. The merchant is also known as the payee.


email_address
string <merchant_common_email_address_v2>  (email)   [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...
The email address of merchant.


 
merchant_id
string <ppaas_payer_id_v3>  (PayPal Account Identifier)   = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The encrypted PayPal account ID of the merchant.


 
{
  • "email_address": "string",
  • "merchant_id": "string"
}
payee_base
The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.


email_address
string <merchant_common_email_address_v2>  (email)   [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...
The email address of merchant.


 
merchant_id
string <ppaas_payer_id_v3>  (PayPal Account Identifier)   = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The encrypted PayPal account ID of the merchant.


 
{
  • "email_address": "string",
  • "merchant_id": "string"
}
payee_base
The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.


email_address
string <merchant_common_email_address_v2>  (email)   [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...
The email address of merchant.


 
merchant_id
string <ppaas_payer_id_v3>  (PayPal Account Identifier)   = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The encrypted PayPal account ID of the merchant.


 
{
  • "email_address": "string",
  • "merchant_id": "string"
}
payee_payment_method_preference
The merchant-preferred payment methods.


string (payee_payment_method_preference)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
 Default:  "UNRESTRICTED"
The merchant-preferred payment methods.


 Enum Value Description
UNRESTRICTED
Accepts any type of payment from the customer.


IMMEDIATE_PAYMENT_REQUIRED
Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the pending status.


 
"UNRESTRICTED"
payer
The customer who approves and pays for the order. The customer is also known as the payer.


email_address
string <merchant_common_email_address_v2>  (email)   [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...
The email address of the payer.


 
payer_id
string <ppaas_payer_id_v3>  (PayPal Account Identifier)   = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The PayPal-assigned ID for the payer.


 
object (Name) 
The name of the payer. Supports only the given_name and surname properties.


 
object (phone_with_type) 
The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The phone.phone_number supports only national_number.


 
birth_date
string <ppaas_date_notime_v2>  (date_no_time)   = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The birth date of the payer in YYYY-MM-DD format.


 
object (tax_info) 
The tax information of the payer. Required only for Brazilian payer's. Both tax_id and tax_id_type are required.


 
object (Portable Postal Address (Medium-Grained)) 
The address of the payer. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer.


 
{
  • "email_address": "string",
  • "payer_id": "string",
  • "name": {
    • "given_name": "string",
    • "surname": "string"
    },
  • "phone": {
    • "phone_type": "FAX",
    • "phone_number": {
      • "national_number": "string"
      }
    },
  • "birth_date": "stringstri",
  • "tax_info": {
    • "tax_id": "string",
    • "tax_id_type": "BR_CPF"
    },
  • "address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    }
}
payer_base
The customer who approves and pays for the order. The customer is also known as the payer.


email_address
string <merchant_common_email_address_v2>  (email)   [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...
The email address of the payer.


 
payer_id
string <ppaas_payer_id_v3>  (PayPal Account Identifier)   = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The PayPal-assigned ID for the payer.


 
{
  • "email_address": "string",
  • "payer_id": "string"
}
Payment Collection
The collection of payments, or transactions, for a purchase unit in an order. For example, authorized payments, captured payments, and refunds.


Array of objects (authorization_with_additional_data) 
An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments.


 
Array of objects (capture) 
An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments.


 
Array of objects (refund) 
An array of refunds for a purchase unit. A purchase unit can have zero or more refunds.


 
{
  • "authorizations": [
    • {
      • "status": "CREATED",
      • "status_details": {
        • "reason": "PENDING_REVIEW"
        },
      • "id": "string",
      • "invoice_id": "string",
      • "custom_id": "string",
      • "links": [
        • {
          • "href": "string",
          • "rel": "string",
          • "method": "GET"
          }
        ],
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        },
      • "seller_protection": {
        • "status": "ELIGIBLE",
        • "dispute_categories": [
          • "string"
          ]
        },
      • "expiration_time": "string",
      • "create_time": "string",
      • "update_time": "string",
      • "processor_response": {
        • "avs_code": "A",
        • "cvv_code": "E",
        • "response_code": "0000",
        • "payment_advice_code": "01"
        }
      }
    ],
  • "captures": [
    • {
      • "create_time": "string",
      • "update_time": "string",
      • "id": "string",
      • "invoice_id": "string",
      • "custom_id": "string",
      • "final_capture": false,
      • "links": [
        • {
          • "href": "string",
          • "rel": "string",
          • "method": "GET"
          }
        ],
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        },
      • "seller_protection": {
        • "status": "ELIGIBLE",
        • "dispute_categories": [
          • "string"
          ]
        },
      • "seller_receivable_breakdown": {
        • "platform_fees": [
          • {
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "payee": {
              • "email_address": "string",
              • "merchant_id": "string"
              }
            }
          ],
        • "gross_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "paypal_fee": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "paypal_fee_in_receivable_currency": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "net_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "receivable_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "exchange_rate": {
          • "value": "string",
          • "source_currency": "str",
          • "target_currency": "str"
          }
        },
      • "disbursement_mode": "INSTANT",
      • "processor_response": {
        • "avs_code": "A",
        • "cvv_code": "E",
        • "response_code": "0000",
        • "payment_advice_code": "01"
        }
      }
    ],
  • "refunds": [
    • {
      • "status": "CANCELLED",
      • "status_details": {
        • "reason": "ECHECK"
        },
      • "id": "string",
      • "invoice_id": "string",
      • "custom_id": "string",
      • "acquirer_reference_number": "string",
      • "note_to_payer": "string",
      • "seller_payable_breakdown": {
        • "platform_fees": [
          • {
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "payee": {
              • "email_address": "string",
              • "merchant_id": "string"
              }
            }
          ],
        • "net_amount_breakdown": [
          • {
            • "payable_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "converted_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "exchange_rate": {
              • "value": "string",
              • "source_currency": "str",
              • "target_currency": "str"
              }
            }
          ],
        • "gross_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "paypal_fee": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "paypal_fee_in_receivable_currency": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "net_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "net_amount_in_receivable_currency": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "total_refunded_amount": {
          • "currency_code": "str",
          • "value": "string"
          }
        },
      • "links": [
        • {
          • "href": "string",
          • "rel": "string",
          • "method": "GET"
          }
        ],
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "payer": {
        • "email_address": "string",
        • "merchant_id": "string"
        },
      • "create_time": "string",
      • "update_time": "string"
      }
    ]
}
payment_initiator
The person or party who initiated or triggered the payment.


string (payment_initiator)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The person or party who initiated or triggered the payment.


 Enum Value Description
CUSTOMER
Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website.


MERCHANT
Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer.


 
"CUSTOMER"
payment_instruction
Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.


Array of objects (platform_fee)   [ 0 .. 1 ] items 
An array of various fees, commissions, tips, or donations. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability.


 
payee_pricing_tier_id
string  [ 1 .. 20 ] characters ^.*$
This field is only enabled for selected merchants/partners to use and provides the ability to trigger a specific pricing rate/plan for a payment transaction. The list of eligible 'payee_pricing_tier_id' would be provided to you by your Account Manager. Specifying values other than the one provided to you by your account manager would result in an error.


 
payee_receivable_fx_rate_id
string  [ 1 .. 4000 ] characters ^.*$
FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account.


 
disbursement_mode
string (disbursement_mode)   [ 1 .. 16 ] characters ^[A-Z_]+$
 Default:  "INSTANT"
The funds that are held payee by the marketplace/platform. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability.


 Enum Value Description
INSTANT
The funds are released to the merchant immediately.


DELAYED
The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration.


 
{
  • "platform_fees": [
    • {
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "payee": {
        • "email_address": "string",
        • "merchant_id": "string"
        }
      }
    ],
  • "payee_pricing_tier_id": "string",
  • "payee_receivable_fx_rate_id": "string",
  • "disbursement_mode": "INSTANT"
}
payment_method
The customer and merchant payment preferences.


standard_entry_class_code
string  [ 3 .. 255 ] characters 
 Default:  "WEB"
NACHA (the regulatory body governing the ACH network) requires that API callers (merchants, partners) obtain the consumer’s explicit authorization before initiating a transaction. To stay compliant, you’ll need to make sure that you retain a compliant authorization for each transaction that you originate to the ACH Network using this API. ACH transactions are categorized (using SEC codes) by how you capture authorization from the Receiver (the person whose bank account is being debited or credited). PayPal supports the following SEC codes.


 Enum Value Description
TEL
The API caller (merchant/partner) accepts authorization and payment information from a consumer over the telephone.


WEB
The API caller (merchant/partner) accepts Debit transactions from a consumer on their website.


CCD
Cash concentration and disbursement for corporate debit transaction. Used to disburse or consolidate funds. Entries are usually Optional high-dollar, low-volume, and time-critical. (e.g. intra-company transfers or invoice payments to suppliers).


PPD
Prearranged payment and deposit entries. Used for debit payments authorized by a consumer account holder, and usually initiated by a company. These are usually recurring debits (such as insurance premiums).


 
payee_preferred
string (payee_payment_method_preference)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
 Default:  "UNRESTRICTED"
The merchant-preferred payment methods.


 Enum Value Description
UNRESTRICTED
Accepts any type of payment from the customer.


IMMEDIATE_PAYMENT_REQUIRED
Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the pending status.


 
{
  • "standard_entry_class_code": "TEL",
  • "payee_preferred": "UNRESTRICTED"
}
payment_source
The payment source definition.


object (card_request) 
The payment card to use to fund a payment. Can be a credit or debit card.
Note: Passing card number, cvv and expiry directly via the API requires  PCI SAQ D compliance. 
PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide.


 
object (token) 
The tokenized payment source to fund a payment.


 
object (paypal_wallet) 
Indicates that PayPal Wallet is the payment source. Main use of this selection is to provide additional instructions associated with this choice like vaulting.


 
object (bancontact_request) 
Bancontact is the most popular online payment in Belgium. More Details.


 
object (blik_request) 
BLIK is a mobile payment system, created by Polish Payment Standard in order to allow millions of users to pay in shops, payout cash in ATMs and make online purchases and payments. More Details.


 
object (eps_request) 
The eps transfer is an online payment method developed by many Austrian banks. More Details.


 
object (giropay_request) 
Giropay is an Internet payment System in Germany, based on online banking. More Details.


 
object (ideal_request) 
The Dutch payment method iDEAL is an online payment method that enables consumers to pay online through their own bank. More Details.


 
object (mybank_request) 
MyBank is an e-authorisation solution which enables safe digital payments and identity authentication through a consumer’s own online banking portal or mobile application. More Details.


 
object (p24_request) 
P24 (Przelewy24) is a secure and fast online bank transfer service linked to all the major banks in Poland. More Details.


 
object (sofort_request) 
SOFORT Banking is a real-time bank transfer payment method that buyers use to transfer funds directly to merchants from their bank accounts. More Details.


 
object (trustly_request) 
Trustly is a payment method that allows customers to shop and pay from their bank account. More Details.


 
object (apple_pay_request) 
ApplePay payment source, allows buyer to pay using ApplePay, both on Web as well as on Native.


 
object (google_pay_request) 
Google Pay payment source, allows buyer to pay using Google Pay.


 
object (venmo_wallet_request) 
Information needed to indicate that Venmo is being used to fund the payment.


 
{
  • "card": {
    • "name": "string",
    • "number": "stringstrings",
    • "security_code": "stri",
    • "expiry": "string",
    • "billing_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      },
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          },
        • "merchant_customer_id": "string"
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS"
        },
      • "verification": {
        • "method": "SCA_ALWAYS"
        }
      },
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        }
      },
    • "vault_id": "string",
    • "single_use_token": "string",
    • "network_token": {
      • "number": "stringstrings",
      • "cryptogram": "stringstringstringstringstri",
      • "token_requestor_id": "string",
      • "expiry": "string",
      • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION"
      },
    • "experience_context": {
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "token": {
    • "id": "string",
    • "type": "BILLING_AGREEMENT"
    },
  • "paypal": {
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "contact_preference": "NO_CONTACT_INFO",
      • "landing_page": "LOGIN",
      • "user_action": "CONTINUE",
      • "payment_method_preference": "UNRESTRICTED",
      • "locale": "string",
      • "return_url": "string",
      • "cancel_url": "string",
      • "order_update_callback_config": {}
      },
    • "billing_agreement_id": "string",
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "charge_pattern": "IMMEDIATE",
      • "usage_pattern": "IMMEDIATE",
      • "usage": "FIRST"
      },
    • "vault_id": "string",
    • "email_address": "string",
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "birth_date": "stringstri",
    • "tax_info": {
      • "tax_id": "string",
      • "tax_id_type": "BR_CPF"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      },
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          },
        • "merchant_customer_id": "string"
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS",
        • "description": "string",
        • "usage_pattern": "string",
        • "usage_type": "string",
        • "customer_type": "CONSUMER",
        • "permit_multiple_payment_tokens": false
        }
      }
    },
  • "bancontact": {
    • "name": "string",
    • "country_code": "string",
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "locale": "string",
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "blik": {
    • "name": "string",
    • "country_code": "string",
    • "email": "string",
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "locale": "string",
      • "return_url": "string",
      • "cancel_url": "string",
      • "consumer_user_agent": "string",
      • "consumer_ip": "string"
      },
    • "level_0": {
      • "auth_code": "string"
      },
    • "one_click": {
      • "auth_code": "string",
      • "consumer_reference": "string",
      • "alias_label": "stringst",
      • "alias_key": "string"
      }
    },
  • "eps": {
    • "name": "string",
    • "country_code": "string",
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "locale": "string",
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "giropay": {
    • "name": "string",
    • "country_code": "string",
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "locale": "string",
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "ideal": {
    • "name": "string",
    • "country_code": "string",
    • "bic": "string",
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "locale": "string",
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "mybank": {
    • "name": "string",
    • "country_code": "string",
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "locale": "string",
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "p24": {
    • "name": "string",
    • "email": "string",
    • "country_code": "string",
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "locale": "string",
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "sofort": {
    • "name": "string",
    • "country_code": "string",
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "locale": "string",
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "trustly": {
    • "name": "string",
    • "country_code": "string",
    • "email": "string",
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "locale": "string",
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "apple_pay": {
    • "id": "string",
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        }
      },
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          }
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS"
        }
      },
    • "name": "string",
    • "email_address": "string",
    • "phone_number": {
      • "national_number": "string"
      },
    • "decrypted_token": {
      • "device_manufacturer_id": "string",
      • "payment_data_type": "3DSECURE",
      • "transaction_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "tokenized_card": {
        • "name": "string",
        • "number": "stringstrings",
        • "expiry": "string",
        • "card_type": "VISA",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        },
      • "payment_data": {
        • "cryptogram": "string",
        • "eci_indicator": "string",
        • "emv_data": "string",
        • "pin": "string"
        }
      },
    • "vault_id": "string",
    • "experience_context": {
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "google_pay": {
    • "name": "string",
    • "email_address": "string",
    • "phone_number": {
      • "country_code": "str",
      • "national_number": "string"
      },
    • "card": {
      • "name": "string",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        }
      },
    • "decrypted_token": {
      • "message_id": "string",
      • "message_expiration": "stringstrings",
      • "payment_method": "CARD",
      • "authentication_method": "PAN_ONLY",
      • "cryptogram": "string",
      • "eci_indicator": "string",
      • "card": {
        • "name": "string",
        • "number": "stringstrings",
        • "last_digits": "stri",
        • "expiry": "string",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        }
      },
    • "assurance_details": {
      • "account_verified": false,
      • "card_holder_authenticated": false
      },
    • "experience_context": {
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "venmo": {
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "order_update_callback_config": {}
      },
    • "vault_id": "string",
    • "email_address": "string",
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          }
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS",
        • "description": "string",
        • "usage_pattern": "string",
        • "usage_type": "string",
        • "customer_type": "CONSUMER",
        • "permit_multiple_payment_tokens": false
        }
      }
    }
}
payment_source
The payment source definition.


object (card_request) 
The payment card to use to fund a payment. Can be a credit or debit card.
Note: Passing card number, cvv and expiry directly via the API requires  PCI SAQ D compliance. 
PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide.


 
object (token) 
The tokenized payment source to fund a payment.


 
object (paypal_wallet) 
Indicates that PayPal Wallet is the payment source. Main use of this selection is to provide additional instructions associated with this choice like vaulting.


 
object (apple_pay_request) 
ApplePay payment source, allows buyer to pay using ApplePay, both on Web as well as on Native.


 
object (google_pay_request) 
Google Pay payment source, allows buyer to pay using Google Pay.


 
object (venmo_wallet_request) 
Information needed to indicate that Venmo is being used to fund the payment.


 
{
  • "card": {
    • "name": "string",
    • "number": "stringstrings",
    • "security_code": "stri",
    • "expiry": "string",
    • "billing_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      },
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          },
        • "merchant_customer_id": "string"
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS"
        },
      • "verification": {
        • "method": "SCA_ALWAYS"
        }
      },
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        }
      },
    • "vault_id": "string",
    • "single_use_token": "string",
    • "network_token": {
      • "number": "stringstrings",
      • "cryptogram": "stringstringstringstringstri",
      • "token_requestor_id": "string",
      • "expiry": "string",
      • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION"
      },
    • "experience_context": {
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "token": {
    • "id": "string",
    • "type": "BILLING_AGREEMENT"
    },
  • "paypal": {
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "contact_preference": "NO_CONTACT_INFO",
      • "landing_page": "LOGIN",
      • "user_action": "CONTINUE",
      • "payment_method_preference": "UNRESTRICTED",
      • "locale": "string",
      • "return_url": "string",
      • "cancel_url": "string",
      • "order_update_callback_config": {}
      },
    • "billing_agreement_id": "string",
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "charge_pattern": "IMMEDIATE",
      • "usage_pattern": "IMMEDIATE",
      • "usage": "FIRST"
      },
    • "vault_id": "string",
    • "email_address": "string",
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "birth_date": "stringstri",
    • "tax_info": {
      • "tax_id": "string",
      • "tax_id_type": "BR_CPF"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      },
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          },
        • "merchant_customer_id": "string"
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS",
        • "description": "string",
        • "usage_pattern": "string",
        • "usage_type": "string",
        • "customer_type": "CONSUMER",
        • "permit_multiple_payment_tokens": false
        }
      }
    },
  • "apple_pay": {
    • "id": "string",
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        }
      },
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          }
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS"
        }
      },
    • "name": "string",
    • "email_address": "string",
    • "phone_number": {
      • "national_number": "string"
      },
    • "decrypted_token": {
      • "device_manufacturer_id": "string",
      • "payment_data_type": "3DSECURE",
      • "transaction_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "tokenized_card": {
        • "name": "string",
        • "number": "stringstrings",
        • "expiry": "string",
        • "card_type": "VISA",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        },
      • "payment_data": {
        • "cryptogram": "string",
        • "eci_indicator": "string",
        • "emv_data": "string",
        • "pin": "string"
        }
      },
    • "vault_id": "string",
    • "experience_context": {
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "google_pay": {
    • "name": "string",
    • "email_address": "string",
    • "phone_number": {
      • "country_code": "str",
      • "national_number": "string"
      },
    • "card": {
      • "name": "string",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        }
      },
    • "decrypted_token": {
      • "message_id": "string",
      • "message_expiration": "stringstrings",
      • "payment_method": "CARD",
      • "authentication_method": "PAN_ONLY",
      • "cryptogram": "string",
      • "eci_indicator": "string",
      • "card": {
        • "name": "string",
        • "number": "stringstrings",
        • "last_digits": "stri",
        • "expiry": "string",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        }
      },
    • "assurance_details": {
      • "account_verified": false,
      • "card_holder_authenticated": false
      },
    • "experience_context": {
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "venmo": {
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "order_update_callback_config": {}
      },
    • "vault_id": "string",
    • "email_address": "string",
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          }
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS",
        • "description": "string",
        • "usage_pattern": "string",
        • "usage_type": "string",
        • "customer_type": "CONSUMER",
        • "permit_multiple_payment_tokens": false
        }
      }
    }
}
payment_source
The payment source definition.


object (card_request) 
The payment card to use to fund a payment. Can be a credit or debit card.
Note: Passing card number, cvv and expiry directly via the API requires  PCI SAQ D compliance. 
PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide.


 
object (token) 
The tokenized payment source to fund a payment.


 
object (paypal_wallet) 
Indicates that PayPal Wallet is the payment source. Main use of this selection is to provide additional instructions associated with this choice like vaulting.


 
object (apple_pay_request) 
ApplePay payment source, allows buyer to pay using ApplePay, both on Web as well as on Native.


 
object (google_pay_request) 
Google Pay payment source, allows buyer to pay using Google Pay.


 
object (venmo_wallet_request) 
Information needed to indicate that Venmo is being used to fund the payment.


 
{
  • "card": {
    • "name": "string",
    • "number": "stringstrings",
    • "security_code": "stri",
    • "expiry": "string",
    • "billing_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      },
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          },
        • "merchant_customer_id": "string"
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS"
        },
      • "verification": {
        • "method": "SCA_ALWAYS"
        }
      },
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        }
      },
    • "vault_id": "string",
    • "single_use_token": "string",
    • "network_token": {
      • "number": "stringstrings",
      • "cryptogram": "stringstringstringstringstri",
      • "token_requestor_id": "string",
      • "expiry": "string",
      • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION"
      },
    • "experience_context": {
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "token": {
    • "id": "string",
    • "type": "BILLING_AGREEMENT"
    },
  • "paypal": {
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "contact_preference": "NO_CONTACT_INFO",
      • "landing_page": "LOGIN",
      • "user_action": "CONTINUE",
      • "payment_method_preference": "UNRESTRICTED",
      • "locale": "string",
      • "return_url": "string",
      • "cancel_url": "string",
      • "order_update_callback_config": {}
      },
    • "billing_agreement_id": "string",
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "charge_pattern": "IMMEDIATE",
      • "usage_pattern": "IMMEDIATE",
      • "usage": "FIRST"
      },
    • "vault_id": "string",
    • "email_address": "string",
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "birth_date": "stringstri",
    • "tax_info": {
      • "tax_id": "string",
      • "tax_id_type": "BR_CPF"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      },
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          },
        • "merchant_customer_id": "string"
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS",
        • "description": "string",
        • "usage_pattern": "string",
        • "usage_type": "string",
        • "customer_type": "CONSUMER",
        • "permit_multiple_payment_tokens": false
        }
      }
    },
  • "apple_pay": {
    • "id": "string",
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        }
      },
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          }
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS"
        }
      },
    • "name": "string",
    • "email_address": "string",
    • "phone_number": {
      • "national_number": "string"
      },
    • "decrypted_token": {
      • "device_manufacturer_id": "string",
      • "payment_data_type": "3DSECURE",
      • "transaction_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "tokenized_card": {
        • "name": "string",
        • "number": "stringstrings",
        • "expiry": "string",
        • "card_type": "VISA",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        },
      • "payment_data": {
        • "cryptogram": "string",
        • "eci_indicator": "string",
        • "emv_data": "string",
        • "pin": "string"
        }
      },
    • "vault_id": "string",
    • "experience_context": {
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "google_pay": {
    • "name": "string",
    • "email_address": "string",
    • "phone_number": {
      • "country_code": "str",
      • "national_number": "string"
      },
    • "card": {
      • "name": "string",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        }
      },
    • "decrypted_token": {
      • "message_id": "string",
      • "message_expiration": "stringstrings",
      • "payment_method": "CARD",
      • "authentication_method": "PAN_ONLY",
      • "cryptogram": "string",
      • "eci_indicator": "string",
      • "card": {
        • "name": "string",
        • "number": "stringstrings",
        • "last_digits": "stri",
        • "expiry": "string",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        }
      },
    • "assurance_details": {
      • "account_verified": false,
      • "card_holder_authenticated": false
      },
    • "experience_context": {
      • "return_url": "string",
      • "cancel_url": "string"
      }
    },
  • "venmo": {
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "order_update_callback_config": {}
      },
    • "vault_id": "string",
    • "email_address": "string",
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          }
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS",
        • "description": "string",
        • "usage_pattern": "string",
        • "usage_type": "string",
        • "customer_type": "CONSUMER",
        • "permit_multiple_payment_tokens": false
        }
      }
    }
}
payment_source_response
The payment source used to fund the payment.


object (card_response) 
The payment card to use to fund a payment. Card can be a credit or debit card.


 
object (bancontact) 
Information used to pay Bancontact.


 
object (blik) 
Information used to pay using BLIK.


 
object (eps) 
Information used to pay using eps.


 
object (giropay) 
Information needed to pay using giropay.


 
object (ideal) 
Information used to pay using iDEAL.


 
object (mybank) 
Information used to pay using MyBank.


 
object (p24) 
Information used to pay using P24(Przelewy24).


 
object (sofort) 
Information used to pay using Sofort.


 
object (trustly) 
Information needed to pay using Trustly.


 
object (venmo_wallet_response) 
Venmo wallet response.


 
object (paypal_wallet_response) 
The PayPal Wallet response.


 
object (apple_pay) 
Information needed to pay using ApplePay.


 
object (google_pay) 
Google Pay Wallet payment data.


 
{
  • "card": {
    • "name": "string",
    • "last_digits": "string",
    • "available_networks": [
      • "VISA"
      ],
    • "from_request": {
      • "last_digits": "stri",
      • "expiry": "string"
      },
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        }
      },
    • "brand": "VISA",
    • "type": "CREDIT",
    • "authentication_result": {
      • "liability_shift": "NO",
      • "three_d_secure": {
        • "authentication_status": "Y",
        • "enrollment_status": "Y"
        }
      },
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "links": [
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "GET"
            }
          ],
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            },
          • "merchant_customer_id": "string"
          }
        }
      },
    • "expiry": "string",
    • "bin_details": {
      • "bin": "string",
      • "issuing_bank": "string",
      • "products": [
        • "string"
        ],
      • "bin_country_code": "string"
      }
    },
  • "bancontact": {
    • "card_last_digits": "stri",
    • "name": "string",
    • "country_code": "string",
    • "bic": "string",
    • "iban_last_chars": "string"
    },
  • "blik": {
    • "name": "string",
    • "country_code": "string",
    • "email": "string",
    • "one_click": {
      • "consumer_reference": "string"
      }
    },
  • "eps": {
    • "name": "string",
    • "country_code": "string",
    • "bic": "string"
    },
  • "giropay": {
    • "name": "string",
    • "country_code": "string",
    • "bic": "string"
    },
  • "ideal": {
    • "name": "string",
    • "country_code": "string",
    • "bic": "string",
    • "iban_last_chars": "string"
    },
  • "mybank": {
    • "name": "string",
    • "country_code": "string",
    • "bic": "string",
    • "iban_last_chars": "string"
    },
  • "p24": {
    • "payment_descriptor": "string",
    • "method_id": "string",
    • "method_description": "string",
    • "name": "string",
    • "email": "string",
    • "country_code": "string"
    },
  • "sofort": {
    • "name": "string",
    • "country_code": "string",
    • "bic": "string",
    • "iban_last_chars": "string"
    },
  • "trustly": {
    • "name": "string",
    • "country_code": "string",
    • "email": "string",
    • "bic": "string",
    • "iban_last_chars": "string"
    },
  • "venmo": {
    • "user_name": "string",
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "links": [
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "GET"
            }
          ],
        • "customer": {
          • "id": "string",
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            }
          }
        }
      },
    • "email_address": "string",
    • "account_id": "stringstrings",
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "phone_number": {
      • "national_number": "string"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      }
    },
  • "paypal": {
    • "account_status": "VERIFIED",
    • "phone_type": "FAX",
    • "business_name": "string",
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "links": [
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "GET"
            }
          ],
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            },
          • "merchant_customer_id": "string"
          }
        },
      • "cobranded_cards": [
        • {
          • "labels": [
            • "string"
            ],
          • "payee": {
            • "email_address": "string",
            • "merchant_id": "string"
            },
          • "amount": {
            • "currency_code": "str",
            • "value": "string"
            }
          }
        ]
      },
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "charge_pattern": "IMMEDIATE",
      • "usage_pattern": "IMMEDIATE",
      • "usage": "FIRST"
      },
    • "email_address": "string",
    • "account_id": "stringstrings",
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "phone_number": {
      • "national_number": "string"
      },
    • "birth_date": "stringstri",
    • "tax_info": {
      • "tax_id": "string",
      • "tax_id_type": "BR_CPF"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      }
    },
  • "apple_pay": {
    • "id": "string",
    • "token": "string",
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        }
      },
    • "name": "string",
    • "email_address": "string",
    • "phone_number": {
      • "national_number": "string"
      },
    • "card": {
      • "name": "string",
      • "last_digits": "string",
      • "available_networks": [
        • "VISA"
        ],
      • "from_request": {
        • "last_digits": "stri",
        • "expiry": "string"
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "brand": "VISA",
      • "type": "CREDIT",
      • "authentication_result": {
        • "liability_shift": "NO",
        • "three_d_secure": {
          • "authentication_status": "Y",
          • "enrollment_status": "Y"
          }
        },
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "links": [
            • {
              • "href": "string",
              • "rel": "string",
              • "method": "GET"
              }
            ],
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "given_name": "string",
              • "surname": "string"
              },
            • "merchant_customer_id": "string"
            }
          }
        },
      • "expiry": "string",
      • "bin_details": {
        • "bin": "string",
        • "issuing_bank": "string",
        • "products": [
          • "string"
          ],
        • "bin_country_code": "string"
        },
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        },
      • "country_code": "string"
      },
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "links": [
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "GET"
            }
          ],
        • "customer": {
          • "id": "string",
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            }
          }
        }
      }
    },
  • "google_pay": {
    • "name": "string",
    • "email_address": "string",
    • "phone_number": {
      • "country_code": "str",
      • "national_number": "string"
      },
    • "card": {
      • "name": "string",
      • "last_digits": "stri",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        },
      • "authentication_result": {
        • "liability_shift": "NO",
        • "three_d_secure": {
          • "authentication_status": "Y",
          • "enrollment_status": "Y"
          }
        }
      }
    }
}
payment_source_response
The payment source used to fund the payment.


object (card_response) 
The payment card to use to fund a payment. Card can be a credit or debit card.


 
object (venmo_wallet_response) 
Venmo wallet response.


 
object (paypal_wallet_response) 
The PayPal Wallet response.


 
object (apple_pay) 
Information needed to pay using ApplePay.


 
object (google_pay) 
Google Pay Wallet payment data.


 
{
  • "card": {
    • "name": "string",
    • "last_digits": "string",
    • "available_networks": [
      • "VISA"
      ],
    • "from_request": {
      • "last_digits": "stri",
      • "expiry": "string"
      },
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        }
      },
    • "brand": "VISA",
    • "type": "CREDIT",
    • "authentication_result": {
      • "liability_shift": "NO",
      • "three_d_secure": {
        • "authentication_status": "Y",
        • "enrollment_status": "Y"
        }
      },
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "links": [
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "GET"
            }
          ],
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            },
          • "merchant_customer_id": "string"
          }
        }
      },
    • "expiry": "string",
    • "bin_details": {
      • "bin": "string",
      • "issuing_bank": "string",
      • "products": [
        • "string"
        ],
      • "bin_country_code": "string"
      }
    },
  • "venmo": {
    • "user_name": "string",
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "links": [
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "GET"
            }
          ],
        • "customer": {
          • "id": "string",
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            }
          }
        }
      },
    • "email_address": "string",
    • "account_id": "stringstrings",
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "phone_number": {
      • "national_number": "string"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      }
    },
  • "paypal": {
    • "account_status": "VERIFIED",
    • "phone_type": "FAX",
    • "business_name": "string",
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "links": [
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "GET"
            }
          ],
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            },
          • "merchant_customer_id": "string"
          }
        },
      • "cobranded_cards": [
        • {
          • "labels": [
            • "string"
            ],
          • "payee": {
            • "email_address": "string",
            • "merchant_id": "string"
            },
          • "amount": {
            • "currency_code": "str",
            • "value": "string"
            }
          }
        ]
      },
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "charge_pattern": "IMMEDIATE",
      • "usage_pattern": "IMMEDIATE",
      • "usage": "FIRST"
      },
    • "email_address": "string",
    • "account_id": "stringstrings",
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "phone_number": {
      • "national_number": "string"
      },
    • "birth_date": "stringstri",
    • "tax_info": {
      • "tax_id": "string",
      • "tax_id_type": "BR_CPF"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      }
    },
  • "apple_pay": {
    • "id": "string",
    • "token": "string",
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "acquirer_reference_number": "string",
        • "network": "VISA"
        }
      },
    • "name": "string",
    • "email_address": "string",
    • "phone_number": {
      • "national_number": "string"
      },
    • "card": {
      • "name": "string",
      • "last_digits": "string",
      • "available_networks": [
        • "VISA"
        ],
      • "from_request": {
        • "last_digits": "stri",
        • "expiry": "string"
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          }
        },
      • "brand": "VISA",
      • "type": "CREDIT",
      • "authentication_result": {
        • "liability_shift": "NO",
        • "three_d_secure": {
          • "authentication_status": "Y",
          • "enrollment_status": "Y"
          }
        },
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "links": [
            • {
              • "href": "string",
              • "rel": "string",
              • "method": "GET"
              }
            ],
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "given_name": "string",
              • "surname": "string"
              },
            • "merchant_customer_id": "string"
            }
          }
        },
      • "expiry": "string",
      • "bin_details": {
        • "bin": "string",
        • "issuing_bank": "string",
        • "products": [
          • "string"
          ],
        • "bin_country_code": "string"
        },
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        },
      • "country_code": "string"
      },
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "links": [
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "GET"
            }
          ],
        • "customer": {
          • "id": "string",
          • "name": {
            • "given_name": "string",
            • "surname": "string"
            }
          }
        }
      }
    },
  • "google_pay": {
    • "name": "string",
    • "email_address": "string",
    • "phone_number": {
      • "country_code": "str",
      • "national_number": "string"
      },
    • "card": {
      • "name": "string",
      • "last_digits": "stri",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        },
      • "authentication_result": {
        • "liability_shift": "NO",
        • "three_d_secure": {
          • "authentication_status": "Y",
          • "enrollment_status": "Y"
          }
        }
      }
    }
}
PayPal Account Identifier
The account identifier for a PayPal account.


string <ppaas_payer_id_v3>  (PayPal Account Identifier)   = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The account identifier for a PayPal account.


 
"stringstrings"
paypal_wallet
A resource that identifies a PayPal Wallet is used for payment.


object (paypal_wallet_experience_context) 
Customizes the payer experience during the approval process for payment with PayPal.
Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values.


 
billing_agreement_id
string (billing_agreement_id)   [ 2 .. 128 ] characters ^[a-zA-Z0-9-]+$
The PayPal billing agreement ID. References an approved recurring payment for goods or services.


 
object (paypal_wallet_stored_credential) 
Provides additional details to process a payment using the PayPal wallet billing agreement or a vaulted payment method that has been stored or is intended to be stored.


 
vault_id
string (vault_id)   [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the payment_source stored within the Vault.


 
email_address
string <merchant_common_email_address_v2>  (email)   [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...
The email address of the PayPal account holder.


 
object (Name) 
The name of the PayPal account holder. Supports only the given_name and surname properties.


 
object (phone_with_type) 
The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The phone.phone_number supports only national_number.


 
birth_date
string <ppaas_date_notime_v2>  (date_no_time)   = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The birth date of the PayPal account holder in YYYY-MM-DD format.


 
object (tax_info) 
The tax information of the PayPal account holder. Required only for Brazilian PayPal account holder's. Both tax_id and tax_id_type are required.


 
object (Portable Postal Address (Medium-Grained)) 
The address of the PayPal account holder. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer.


 
object (paypal_wallet_attributes) 
Additional attributes associated with the use of this wallet.


 
{
  • "experience_context": {
    • "brand_name": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "contact_preference": "NO_CONTACT_INFO",
    • "landing_page": "LOGIN",
    • "user_action": "CONTINUE",
    • "payment_method_preference": "UNRESTRICTED",
    • "locale": "string",
    • "return_url": "string",
    • "cancel_url": "string",
    • "order_update_callback_config": {}
    },
  • "billing_agreement_id": "string",
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "charge_pattern": "IMMEDIATE",
    • "usage_pattern": "IMMEDIATE",
    • "usage": "FIRST"
    },
  • "vault_id": "string",
  • "email_address": "string",
  • "name": {
    • "given_name": "string",
    • "surname": "string"
    },
  • "phone": {
    • "phone_type": "FAX",
    • "phone_number": {
      • "national_number": "string"
      }
    },
  • "birth_date": "stringstri",
  • "tax_info": {
    • "tax_id": "string",
    • "tax_id_type": "BR_CPF"
    },
  • "address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    },
  • "attributes": {
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        },
      • "merchant_customer_id": "string"
      },
    • "vault": {
      • "store_in_vault": "ON_SUCCESS",
      • "description": "string",
      • "usage_pattern": "string",
      • "usage_type": "string",
      • "customer_type": "CONSUMER",
      • "permit_multiple_payment_tokens": false
      }
    }
}
paypal_wallet_attributes
Additional attributes associated with the use of this PayPal Wallet.


object (paypal_wallet_customer) 
The details about a customer in PayPal's system of record.


 
object (vault_paypal_wallet_base) 
Attributes used to provide the instructions during vaulting of the PayPal Wallet.


 
{
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "merchant_customer_id": "string"
    },
  • "vault": {
    • "store_in_vault": "ON_SUCCESS",
    • "description": "string",
    • "usage_pattern": "string",
    • "usage_type": "string",
    • "customer_type": "CONSUMER",
    • "permit_multiple_payment_tokens": false
    }
}
paypal_wallet_attributes_response
Additional attributes associated with the use of a PayPal Wallet.


object (paypal_wallet_vault_response) 
The details about a saved PayPal Wallet payment source.


 
Array of objects (cobranded_card)   [ 0 .. 25 ] items 
An array of merchant cobranded cards used by buyer to complete an order. This array will be present if a merchant has onboarded their cobranded card with PayPal and provided corresponding label(s).


 
{
  • "vault": {
    • "id": "string",
    • "status": "VAULTED",
    • "links": [
      • {
        • "href": "string",
        • "rel": "string",
        • "method": "GET"
        }
      ],
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        },
      • "merchant_customer_id": "string"
      }
    },
  • "cobranded_cards": [
    • {
      • "labels": [
        • "string"
        ],
      • "payee": {
        • "email_address": "string",
        • "merchant_id": "string"
        },
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        }
      }
    ]
}
paypal_wallet_customer
The details about a customer in PayPal's system of record.


id
string (merchant_partner_customer_id)   [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.


 
email_address
string <merchant_common_email_address_v2>  (email)   [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...
Email address of the customer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants.


 
object (phone_with_type) 
The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.


 
object (Name) 
The full name of the customer as provided to the merchant or on file with the merchant.


 
merchant_customer_id
string  [ 1 .. 64 ] characters ^[0-9a-zA-Z-_.^*$@#]+$
Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.


 
{
  • "id": "string",
  • "email_address": "string",
  • "phone": {
    • "phone_type": "FAX",
    • "phone_number": {
      • "national_number": "string"
      }
    },
  • "name": {
    • "given_name": "string",
    • "surname": "string"
    },
  • "merchant_customer_id": "string"
}
paypal_wallet_experience_context
Customizes the payer experience during the approval process for payment with PayPal.
Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values.


brand_name
string  [ 1 .. 127 ] characters ^.*$
The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.


 
shipping_preference
string  [ 1 .. 24 ] characters ^[A-Z_]+$
 Default:  "GET_FROM_FILE"
The location from which the shipping address is derived.


 Enum Value Description
GET_FROM_FILE
Get the customer-provided shipping address on the PayPal site.


NO_SHIPPING
Removes the shipping address information from the API response and the Paypal site. However, the shipping.phone_number and shipping.email_address fields will still be returned to allow for digital goods delivery.


SET_PROVIDED_ADDRESS
Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages.


 
contact_preference
string  [ 1 .. 24 ] characters ^[A-Z_]+$
 Default:  "NO_CONTACT_INFO"
The preference to display the contact information (buyer’s shipping email & phone number) on PayPal's checkout for easy merchant-buyer communication.


 Enum Value Description
NO_CONTACT_INFO
The merchant can opt out of showing buyer's contact information on PayPal checkout.


UPDATE_CONTACT_INFO
The merchant allows buyer to add or update shipping contact information on the PayPal checkout. Please ensure to use this updated information returned in shipping.email_address and shipping.phone_number to contact your buyers.


RETAIN_CONTACT_INFO
The buyer can only see but can not override merchant passed contact information (shipping.email_address and shipping.phone_number) on PayPal checkout. NOTE: If you don't pass the contact information, the behavior is the same as NO_CONTACT_INFO preference.


 
landing_page
string  [ 1 .. 13 ] characters ^[0-9A-Z_]+$
 Default:  "NO_PREFERENCE"
The type of landing page to show on the PayPal site for customer checkout.


 Enum Value Description
LOGIN
When the customer clicks PayPal Checkout, the customer is redirected to a page to log in to PayPal and approve the payment.


GUEST_CHECKOUT
When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or debit card and other relevant billing information required to complete the purchase. This option has previously been also called as 'BILLING'


NO_PREFERENCE
When the customer clicks PayPal Checkout, the customer is redirected to either a page to log in to PayPal and approve the payment or to a page to enter credit or debit card and other relevant billing information required to complete the purchase, depending on their previous interaction with PayPal.


 
user_action
string  [ 1 .. 8 ] characters ^[0-9A-Z_]+$
 Default:  "CONTINUE"
Configures a Continue or Pay Now checkout flow.


 Enum Value Description
CONTINUE
After you redirect the customer to the PayPal payment page, a Continue button appears. Use this option when the final amount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant page without processing the payment.


PAY_NOW
After you redirect the customer to the PayPal payment page, a Pay Now button appears. Use this option when the final amount is known when the checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now.


 
payment_method_preference
string  [ 1 .. 255 ] characters ^[0-9A-Z_]+$
 Default:  "UNRESTRICTED"
The merchant-preferred payment methods.


 Enum Value Description
UNRESTRICTED
Accepts any type of payment from the customer.


IMMEDIATE_PAYMENT_REQUIRED
Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the pending status.


 
locale
string <ppaas_common_language_v3>  (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.


 
return_url
string <uri>  (url) 
The URL where the customer will be redirected upon approving a payment.


 
cancel_url
string <uri>  (url) 
The URL where the customer will be redirected upon cancelling the payment approval.


 
object (callback_configuration) 
Merchant provided Order Update callback configuration for PayPal Wallet.PayPal will call back merchant when the specified event occurs.we recommend merchants to pass both the shipping_options and shipping_address callback events. Not supported when shipping.type is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.


 
{
  • "brand_name": "string",
  • "shipping_preference": "GET_FROM_FILE",
  • "contact_preference": "NO_CONTACT_INFO",
  • "landing_page": "LOGIN",
  • "user_action": "CONTINUE",
  • "payment_method_preference": "UNRESTRICTED",
  • "locale": "string",
  • "return_url": "string",
  • "cancel_url": "string",
  • "order_update_callback_config": {}
}
paypal_wallet_response
The PayPal Wallet response.


account_status
string  [ 1 .. 255 ] characters ^[A-Z_]+$
The account status indicates whether the buyer has verified the financial details associated with their PayPal account.


 Enum Value Description
VERIFIED
The buyer has completed the verification of the financial details associated with this PayPal account. For example: confirming their bank account.


UNVERIFIED
The buyer has not completed the verification of the financial details associated with this PayPal account. For example: confirming their bank account.


 
phone_type
string (Phone Type) 
The phone type.


 Enum: "FAX" "HOME" "MOBILE" "OTHER" "PAGER"  
business_name
string  [ 0 .. 300 ] characters ^.*$
The business name of the PayPal account holder (populated for business accounts only)


 
object (paypal_wallet_attributes_response) 
Additional attributes associated with the use of a PayPal Wallet.


 
object (paypal_wallet_stored_credential) 
Provides additional details to process a payment using the PayPal wallet billing agreement or a vaulted payment method that has been stored or is intended to be stored.


 
email_address
string <merchant_common_email_address_v2>  (email)   [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...
The email address of the PayPal account holder.


 
account_id
string <ppaas_payer_id_v3>  (account_id)   = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The PayPal-assigned ID for the PayPal account holder.


 
object (Name) 
The name of the PayPal account holder. Supports only the given_name and surname properties.


 
object (Phone Number) 
The phone number, in its canonical international E.164 numbering plan format. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. Supports only the national_number property.


 
birth_date
string <ppaas_date_notime_v2>  (date_no_time)   = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The birth date of the PayPal account holder in YYYY-MM-DD format.


 
object (tax_info) 
The tax information of the PayPal account holder. Required only for Brazilian PayPal account holder's. Both tax_id and tax_id_type are required.


 
object (Portable Postal Address (Medium-Grained)) 
The address of the PayPal account holder. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer.


 
{
  • "account_status": "VERIFIED",
  • "phone_type": "FAX",
  • "business_name": "string",
  • "attributes": {
    • "vault": {
      • "id": "string",
      • "status": "VAULTED",
      • "links": [
        • {
          • "href": "string",
          • "rel": "string",
          • "method": "GET"
          }
        ],
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          },
        • "merchant_customer_id": "string"
        }
      },
    • "cobranded_cards": [
      • {
        • "labels": [
          • "string"
          ],
        • "payee": {
          • "email_address": "string",
          • "merchant_id": "string"
          },
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          }
        }
      ]
    },
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "charge_pattern": "IMMEDIATE",
    • "usage_pattern": "IMMEDIATE",
    • "usage": "FIRST"
    },
  • "email_address": "string",
  • "account_id": "stringstrings",
  • "name": {
    • "given_name": "string",
    • "surname": "string"
    },
  • "phone_number": {
    • "national_number": "string"
    },
  • "birth_date": "stringstri",
  • "tax_info": {
    • "tax_id": "string",
    • "tax_id_type": "BR_CPF"
    },
  • "address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    }
}
paypal_wallet_stored_credential
Provides additional details to process a payment using the PayPal wallet billing agreement or a vaulted payment method that has been stored or is intended to be stored.


payment_initiator
required
string (payment_initiator)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The person or party who initiated or triggered the payment.


 Enum Value Description
CUSTOMER
Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website.


MERCHANT
Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer.


 
charge_pattern
string (charge_pattern)   [ 1 .. 30 ] characters ^[A-Z0-9_]+$
DEPRECATED. Expected business/pricing model for the billing agreement, Please use usage_pattern instead.


 Enum Value Description
IMMEDIATE
On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency.


DEFERRED
Pay after use, non-recurring post-paid, variable amount, irregular frequency.


RECURRING_PREPAID
Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered.


RECURRING_POSTPAID
Pay on a fixed date based on usage or consumption after the goods/service is delivered.


THRESHOLD_PREPAID
Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered.


THRESHOLD_POSTPAID
Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered.


SUBSCRIPTION_PREPAID
Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due before the good/service is delivered.


SUBSCRIPTION_POSTPAID
Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due after the goods/services are delivered.


UNSCHEDULED_PREPAID
Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans.


UNSCHEDULED_POSTPAID
Unscheduled card on file plan where the merchant can bill buyer based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans.


INSTALLMENT_PREPAID
Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due before the good/service is delivered.


INSTALLMENT_POSTPAID
Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered.


 
usage_pattern
string (charge_pattern)   [ 1 .. 30 ] characters ^[A-Z0-9_]+$
Expected business/pricing model for the billing agreement.


 Enum Value Description
IMMEDIATE
On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency.


DEFERRED
Pay after use, non-recurring post-paid, variable amount, irregular frequency.


RECURRING_PREPAID
Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered.


RECURRING_POSTPAID
Pay on a fixed date based on usage or consumption after the goods/service is delivered.


THRESHOLD_PREPAID
Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered.


THRESHOLD_POSTPAID
Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered.


SUBSCRIPTION_PREPAID
Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due before the good/service is delivered.


SUBSCRIPTION_POSTPAID
Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due after the goods/services are delivered.


UNSCHEDULED_PREPAID
Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans.


UNSCHEDULED_POSTPAID
Unscheduled card on file plan where the merchant can bill buyer based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans.


INSTALLMENT_PREPAID
Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due before the good/service is delivered.


INSTALLMENT_POSTPAID
Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered.


 
usage
string (stored_payment_source_usage_type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
 Default:  "DERIVED"
Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).


 Enum Value Description
FIRST
Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment.


SUBSEQUENT
Indicates a payment using a stored payment_source which has been successfully used previously for a payment.


DERIVED
Indicates that PayPal will derive the value of FIRST or SUBSEQUENT based on data available to PayPal.


 
{
  • "payment_initiator": "CUSTOMER",
  • "charge_pattern": "IMMEDIATE",
  • "usage_pattern": "IMMEDIATE",
  • "usage": "FIRST"
}
paypal_wallet_vault_response
The details about a saved PayPal Wallet payment source.


id
string  [ 1 .. 255 ] characters 
The PayPal-generated ID for the saved payment source.


 
status
string (Vault Status)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The vault status.


 Enum Value Description
VAULTED
The payment source has been saved in your customer's vault. This vault status reflects /v3/vault status.


CREATED
DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations.


APPROVED
Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault


 
Array of objects (Link Description)   [ 1 .. 10 ] items 
An array of request-related HATEOAS links.


 
object (paypal_wallet_customer) 
The details about a customer in PayPal's system of record.


 
{
  • "id": "string",
  • "status": "VAULTED",
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ],
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      },
    • "merchant_customer_id": "string"
    }
}
Phone
The phone number, in its canonical international E.164 numbering plan format.


national_number
required
string  [ 1 .. 14 ] characters ^[0-9]{1,14}?$
The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).


 
{
  • "national_number": "string"
}
Phone
The phone number, in its canonical international E.164 numbering plan format.


national_number
required
string  [ 1 .. 14 ] characters ^[0-9]{1,14}?$
The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).


 
{
  • "national_number": "string"
}
Phone
The phone number in its canonical international E.164 numbering plan format.


country_code
string  [ 1 .. 3 ] characters ^[0-9]{1,3}?$
The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).


 
national_number
required
string  [ 1 .. 14 ] characters ^[0-9]{1,14}?$
The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).


 
{
  • "country_code": "str",
  • "national_number": "string"
}
Phone
The phone number, in its canonical international E.164 numbering plan format.


country_code
required
string  [ 1 .. 3 ] characters ^[0-9]{1,3}?$
The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).


 
national_number
required
string  [ 1 .. 14 ] characters ^[0-9]{1,14}?$
The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).


 
{
  • "country_code": "str",
  • "national_number": "string"
}
Phone
The phone number, in its canonical international E.164 numbering plan format.


national_number
required
string  [ 1 .. 14 ] characters ^[0-9]{1,14}?$
The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).


 
{
  • "national_number": "string"
}
Phone
The phone number in its canonical international E.164 numbering plan format.


country_code
string  [ 1 .. 3 ] characters ^[0-9]{1,3}?$
The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).


 
national_number
required
string  [ 1 .. 14 ] characters ^[0-9]{1,14}?$
The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).


 
{
  • "country_code": "str",
  • "national_number": "string"
}
Phone Number
The phone number in its canonical international E.164 numbering plan format.


national_number
required
string  [ 1 .. 14 ] characters ^[0-9]{1,14}?$
The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).


 
{
  • "national_number": "string"
}
Phone Type
The phone type.


string (Phone Type) 
The phone type.


 Enum: "FAX" "HOME" "MOBILE" "OTHER" "PAGER"  
"FAX"
phone_with_type
The phone information.


phone_type
string (Phone Type) 
The phone type.


 Enum: "FAX" "HOME" "MOBILE" "OTHER" "PAGER"  
required
object (Phone) 
The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.


 
{
  • "phone_type": "FAX",
  • "phone_number": {
    • "national_number": "string"
    }
}
platform_fee
The platform or partner fee, commission, or brokerage fee that is associated with the transaction. Not a separate or isolated transaction leg from the external perspective. The platform fee is limited in scope and is always associated with the original payment for the purchase unit.


required
object (Money) 
The fee for this transaction.


 
object (payee_base) 
The recipient of the fee for this transaction. If you omit this value, the default is the API caller.


 
{
  • "amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "payee": {
    • "email_address": "string",
    • "merchant_id": "string"
    }
}
Portable Postal Address (Medium-Grained)
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


address_line_1
string  <= 300 characters 
The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.


 
address_line_2
string  <= 300 characters 
The second line of the address, for example, a suite or apartment number.


 
admin_area_2
string  <= 120 characters 
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  <= 300 characters 
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
  • UK. A county.
  • US. A state.
  • Canada. A province.
  • Japan. A prefecture.
  • Switzerland. A kanton.


 
postal_code
string  <= 60 characters 
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st"
}
Portable Postal Address (Medium-Grained)
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


address_line_1
string  <= 300 characters 
The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.


 
address_line_2
string  <= 300 characters 
The second line of the address, for example, a suite or apartment number.


 
admin_area_2
string  <= 120 characters 
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  <= 300 characters 
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
  • UK. A county.
  • US. A state.
  • Canada. A province.
  • Japan. A prefecture.
  • Switzerland. A kanton.


 
postal_code
string  <= 60 characters 
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st"
}
Portable Postal Address (Medium-Grained)
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


address_line_1
string  <= 300 characters 
The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.


 
address_line_2
string  <= 300 characters 
The second line of the address, for example, a suite or apartment number.


 
admin_area_2
string  <= 120 characters 
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  <= 300 characters 
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
  • UK. A county.
  • US. A state.
  • Canada. A province.
  • Japan. A prefecture.
  • Switzerland. A kanton.


 
postal_code
string  <= 60 characters 
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st"
}
Portable Postal Address (Medium-Grained)
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


address_line_1
string  <= 300 characters 
The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.


 
address_line_2
string  <= 300 characters 
The second line of the address, for example, a suite or apartment number.


 
admin_area_2
string  <= 120 characters 
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  <= 300 characters 
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
  • UK. A county.
  • US. A state.
  • Canada. A province.
  • Japan. A prefecture.
  • Switzerland. A kanton.


 
postal_code
string  <= 60 characters 
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st"
}
Portable Postal Address (Medium-Grained)
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


address_line_1
string  <= 300 characters 
The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.


 
address_line_2
string  <= 300 characters 
The second line of the address, for example, a suite or apartment number.


 
admin_area_2
string  <= 120 characters 
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  <= 300 characters 
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
  • UK. A county.
  • US. A state.
  • Canada. A province.
  • Japan. A prefecture.
  • Switzerland. A kanton.


 
postal_code
string  <= 60 characters 
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st"
}
Portable Postal Address (Medium-Grained)
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


address_line_1
string  <= 300 characters 
The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.


 
address_line_2
string  <= 300 characters 
The second line of the address, for example, a suite or apartment number.


 
admin_area_2
string  <= 120 characters 
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  <= 300 characters 
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
  • UK. A county.
  • US. A state.
  • Canada. A province.
  • Japan. A prefecture.
  • Switzerland. A kanton.


 
postal_code
string  <= 60 characters 
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st"
}
Portable Postal Address (Medium-Grained)
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


address_line_1
string  <= 300 characters 
The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.


 
address_line_2
string  <= 300 characters 
The second line of the address, for example, a suite or apartment number.


 
admin_area_2
string  <= 120 characters 
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  <= 300 characters 
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
  • UK. A county.
  • US. A state.
  • Canada. A province.
  • Japan. A prefecture.
  • Switzerland. A kanton.


 
postal_code
string  <= 60 characters 
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st"
}
Portable Postal Address (Medium-Grained)
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


address_line_1
string  <= 300 characters 
The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.


 
address_line_2
string  <= 300 characters 
The second line of the address, for example, a suite or apartment number.


 
admin_area_2
string  <= 120 characters 
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  <= 300 characters 
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
  • UK. A county.
  • US. A state.
  • Canada. A province.
  • Japan. A prefecture.
  • Switzerland. A kanton.


 
postal_code
string  <= 60 characters 
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st"
}
Portable Postal Address (Medium-Grained)
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


address_line_1
string  <= 300 characters 
The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.


 
address_line_2
string  <= 300 characters 
The second line of the address, for example, a suite or apartment number.


 
admin_area_2
string  <= 120 characters 
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  <= 300 characters 
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
  • UK. A county.
  • US. A state.
  • Canada. A province.
  • Japan. A prefecture.
  • Switzerland. A kanton.


 
postal_code
string  <= 60 characters 
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st"
}
Portable Postal Address (Medium-Grained)
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


address_line_1
string  <= 300 characters 
The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.


 
address_line_2
string  <= 300 characters 
The second line of the address, for example, a suite or apartment number.


 
admin_area_2
string  <= 120 characters 
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  <= 300 characters 
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
  • UK. A county.
  • US. A state.
  • Canada. A province.
  • Japan. A prefecture.
  • Switzerland. A kanton.


 
postal_code
string  <= 60 characters 
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st"
}
Portable Postal Address (Medium-Grained)
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


admin_area_2
string  <= 120 characters 
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  <= 300 characters 
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
  • UK. A county.
  • US. A state.
  • Canada. A province.
  • Japan. A prefecture.
  • Switzerland. A kanton.


 
postal_code
string  <= 60 characters 
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st"
}
Portable Postal Address (Medium-Grained)
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


address_line_1
string  <= 300 characters 
The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.


 
address_line_2
string  <= 300 characters 
The second line of the address, for example, a suite or apartment number.


 
admin_area_2
string  <= 120 characters 
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  <= 300 characters 
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
  • UK. A county.
  • US. A state.
  • Canada. A province.
  • Japan. A prefecture.
  • Switzerland. A kanton.


 
postal_code
string  <= 60 characters 
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st"
}
Portable Postal Address (Medium-Grained)
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


address_line_1
string  <= 300 characters 
The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.


 
address_line_2
string  <= 300 characters 
The second line of the address, for example, a suite or apartment number.


 
admin_area_2
string  <= 120 characters 
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  <= 300 characters 
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
  • UK. A county.
  • US. A state.
  • Canada. A province.
  • Japan. A prefecture.
  • Switzerland. A kanton.


 
postal_code
string  <= 60 characters 
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.


 
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st"
}
pricing_scheme
The pricing scheme details.


pricing_model
required
string  [ 1 .. 24 ] characters ^[A-Z_]+$
The pricing model for the billing cycle.


 Enum Value Description
FIXED
A fixed pricing scheme where the customer is charged a fixed amount.


VARIABLE
A variable pricing scheme where the customer is charged a variable amount.


AUTO_RELOAD
A auto-reload pricing scheme where the customer is charged a fixed amount for reload.


 
object (Money) 
The price the customer will be charged based on the pricing model


 
object (Money) 
The threshold amount on which the reload charge would be triggered. This will be associated with the account-balance where if the account-balance goes below this amount then customer would incur reload charge.


 
{
  • "pricing_model": "FIXED",
  • "price": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "reload_threshold_amount": {
    • "currency_code": "str",
    • "value": "string"
    }
}
processor_response
The processor response information for payment requests, such as direct credit card transactions.


avs_code
string
The address verification code for Visa, Discover, Mastercard, or American Express transactions.


 Enum Value Description
0
For Maestro, all address information matches.


1
For Maestro, none of the address information matches.


2
For Maestro, part of the address information matches.


3
For Maestro, the merchant did not provide AVS information. It was not processed.


4
For Maestro, the address was not checked or the acquirer had no response. The service is not available.


A
For Visa, Mastercard, or Discover transactions, the address matches but the zip code does not match. For American Express transactions, the card holder address is correct.


B
For Visa, Mastercard, or Discover transactions, the address matches. International A.


C
For Visa, Mastercard, or Discover transactions, no values match. International N.


D
For Visa, Mastercard, or Discover transactions, the address and postal code match. International X.


E
For Visa, Mastercard, or Discover transactions, not allowed for Internet or phone transactions. For American Express card holder, the name is incorrect but the address and postal code match.


F
For Visa, Mastercard, or Discover transactions, the address and postal code match. UK-specific X. For American Express card holder, the name is incorrect but the address matches.


G
For Visa, Mastercard, or Discover transactions, global is unavailable. Nothing matches.


I
For Visa, Mastercard, or Discover transactions, international is unavailable. Not applicable.


M
For Visa, Mastercard, or Discover transactions, the address and postal code match. For American Express card holder, the name, address, and postal code match.


N
For Visa, Mastercard, or Discover transactions, nothing matches. For American Express card holder, the address and postal code are both incorrect.


P
For Visa, Mastercard, or Discover transactions, postal international Z. Postal code only.


R
For Visa, Mastercard, or Discover transactions, re-try the request. For American Express, the system is unavailable.


S
For Visa, Mastercard, Discover, or American Express, the service is not supported.


U
For Visa, Mastercard, or Discover transactions, the service is unavailable. For American Express, information is not available. For Maestro, the address is not checked or the acquirer had no response. The service is not available.


W
For Visa, Mastercard, or Discover transactions, whole ZIP code. For American Express, the card holder name, address, and postal code are all incorrect.


X
For Visa, Mastercard, or Discover transactions, exact match of the address and the nine-digit ZIP code. For American Express, the card holder name, address, and postal code are all incorrect.


Y
For Visa, Mastercard, or Discover transactions, the address and five-digit ZIP code match. For American Express, the card holder address and postal code are both correct.


Z
For Visa, Mastercard, or Discover transactions, the five-digit ZIP code matches but no address. For American Express, only the card holder postal code is correct.


Null
For Maestro, no AVS response was obtained.


 
cvv_code
string
The card verification value code for for Visa, Discover, Mastercard, or American Express.


 Enum Value Description
0
For Maestro, the CVV2 matched.


1
For Maestro, the CVV2 did not match.


2
For Maestro, the merchant has not implemented CVV2 code handling.


3
For Maestro, the merchant has indicated that CVV2 is not present on card.


4
For Maestro, the service is not available.


E
For Visa, Mastercard, Discover, or American Express, error - unrecognized or unknown response.


I
For Visa, Mastercard, Discover, or American Express, invalid or null.


M
For Visa, Mastercard, Discover, or American Express, the CVV2/CSC matches.


N
For Visa, Mastercard, Discover, or American Express, the CVV2/CSC does not match.


P
For Visa, Mastercard, Discover, or American Express, it was not processed.


S
For Visa, Mastercard, Discover, or American Express, the service is not supported.


U
For Visa, Mastercard, Discover, or American Express, unknown - the issuer is not certified.


X
For Visa, Mastercard, Discover, or American Express, no response. For Maestro, the service is not available.


All others
For Visa, Mastercard, Discover, or American Express, error.


 
response_code
string
Processor response code for the non-PayPal payment processor errors.


 Enum Value Description
1000
PARTIAL_AUTHORIZATION.


1300
INVALID_DATA_FORMAT.


1310
INVALID_AMOUNT.


1312
INVALID_TRANSACTION_CARD_ISSUER_ACQUIRER.


1317
INVALID_CAPTURE_DATE.


1320
INVALID_CURRENCY_CODE.


1330
INVALID_ACCOUNT.


1335
INVALID_ACCOUNT_RECURRING.


1340
INVALID_TERMINAL.


1350
INVALID_MERCHANT.


1352
RESTRICTED_OR_INACTIVE_ACCOUNT.


1360
BAD_PROCESSING_CODE.


1370
INVALID_MCC.


1380
INVALID_EXPIRATION.


1382
INVALID_CARD_VERIFICATION_VALUE.


1384
INVALID_LIFE_CYCLE_OF_TRANSACTION.


1390
INVALID_ORDER.


1393
TRANSACTION_CANNOT_BE_COMPLETED.


5100
GENERIC_DECLINE.


5110
CVV2_FAILURE.


5120
INSUFFICIENT_FUNDS.


5130
INVALID_PIN.


5135
DECLINED_PIN_TRY_EXCEEDED.


5140
CARD_CLOSED.


5150
PICKUP_CARD_SPECIAL_CONDITIONS. Try using another card. Do not retry the same card.


5160
UNAUTHORIZED_USER.


5170
AVS_FAILURE.


5180
INVALID_OR_RESTRICTED_CARD. Try using another card. Do not retry the same card.


5190
SOFT_AVS.


5200
DUPLICATE_TRANSACTION.


5210
INVALID_TRANSACTION.


5400
EXPIRED_CARD.


5500
INCORRECT_PIN_REENTER.


5650
DECLINED_SCA_REQUIRED.


5700
TRANSACTION_NOT_PERMITTED. Outside of scope of accepted business.


5710
TX_ATTEMPTS_EXCEED_LIMIT.


5800
REVERSAL_REJECTED.


5900
INVALID_ISSUE.


5910
ISSUER_NOT_AVAILABLE_NOT_RETRIABLE.


5920
ISSUER_NOT_AVAILABLE_RETRIABLE.


5930
CARD_NOT_ACTIVATED.


5950
DECLINED_DUE_TO_UPDATED_ACCOUNT. External decline as an updated card has been issued.


6300
ACCOUNT_NOT_ON_FILE.


7600
APPROVED_NON_CAPTURE.


7700
ERROR_3DS.


7710
AUTHENTICATION_FAILED.


7800
BIN_ERROR.


7900
PIN_ERROR.


8000
PROCESSOR_SYSTEM_ERROR.


8010
HOST_KEY_ERROR.


8020
CONFIGURATION_ERROR.


8030
UNSUPPORTED_OPERATION.


8100
FATAL_COMMUNICATION_ERROR.


8110
RETRIABLE_COMMUNICATION_ERROR.


8220
SYSTEM_UNAVAILABLE.


9100
DECLINED_PLEASE_RETRY. Retry.


9500
SUSPECTED_FRAUD. Try using another card. Do not retry the same card.


9510
SECURITY_VIOLATION.


9520
LOST_OR_STOLEN. Try using another card. Do not retry the same card.


9530
HOLD_CALL_CENTER. The merchant must call the number on the back of the card. POS scenario.


9540
REFUSED_CARD.


9600
UNRECOGNIZED_RESPONSE_CODE.


0000
APPROVED.


00N7
CVV2_FAILURE_POSSIBLE_RETRY_WITH_CVV.


0100
REFERRAL.


0390
ACCOUNT_NOT_FOUND.


0500
DO_NOT_HONOR.


0580
UNAUTHORIZED_TRANSACTION.


0800
BAD_RESPONSE_REVERSAL_REQUIRED.


0880
CRYPTOGRAPHIC_FAILURE.


0890
UNACCEPTABLE_PIN.


0960
SYSTEM_MALFUNCTION.


0R00
CANCELLED_PAYMENT.


10BR
ISSUER_REJECTED.


PCNR
CONTINGENCIES_NOT_RESOLVED.


PCVV
CVV_FAILURE.


PP06
ACCOUNT_CLOSED. A previously open account is now closed


PPRN
REATTEMPT_NOT_PERMITTED.


PPAD
BILLING_ADDRESS.


PPAB
ACCOUNT_BLOCKED_BY_ISSUER.


PPAE
AMEX_DISABLED.


PPAG
ADULT_GAMING_UNSUPPORTED.


PPAI
AMOUNT_INCOMPATIBLE.


PPAR
AUTH_RESULT.


PPAU
MCC_CODE.


PPAV
ARC_AVS.


PPAX
AMOUNT_EXCEEDED.


PPBG
BAD_GAMING.


PPC2
ARC_CVV.


PPCE
CE_REGISTRATION_INCOMPLETE.


PPCO
COUNTRY.


PPCR
CREDIT_ERROR.


PPCT
CARD_TYPE_UNSUPPORTED.


PPCU
CURRENCY_USED_INVALID.


PPD3
SECURE_ERROR_3DS.


PPDC
DCC_UNSUPPORTED.


PPDI
DINERS_REJECT.


PPDV
AUTH_MESSAGE.


PPDT
DECLINE_THRESHOLD_BREACH.


PPEF
EXPIRED_FUNDING_INSTRUMENT.


PPEL
EXCEEDS_FREQUENCY_LIMIT.


PPER
INTERNAL_SYSTEM_ERROR.


PPEX
EXPIRY_DATE.


PPFE
FUNDING_SOURCE_ALREADY_EXISTS.


PPFI
INVALID_FUNDING_INSTRUMENT.


PPFR
RESTRICTED_FUNDING_INSTRUMENT.


PPFV
FIELD_VALIDATION_FAILED.


PPGR
GAMING_REFUND_ERROR.


PPH1
H1_ERROR.


PPIF
IDEMPOTENCY_FAILURE.


PPII
INVALID_INPUT_FAILURE.


PPIM
ID_MISMATCH.


PPIT
INVALID_TRACE_ID.


PPLR
LATE_REVERSAL.


PPLS
LARGE_STATUS_CODE.


PPMB
MISSING_BUSINESS_RULE_OR_DATA.


PPMC
BLOCKED_Mastercard.


PPMD
DEPRECATED The PPMD value has been deprecated.


PPNC
NOT_SUPPORTED_NRC.


PPNL
EXCEEDS_NETWORK_FREQUENCY_LIMIT.


PPNM
NO_MID_FOUND.


PPNT
NETWORK_ERROR.


PPPH
NO_PHONE_FOR_DCC_TRANSACTION.


PPPI
INVALID_PRODUCT.


PPPM
INVALID_PAYMENT_METHOD.


PPQC
QUASI_CASH_UNSUPPORTED.


PPRE
UNSUPPORT_REFUND_ON_PENDING_BC.


PPRF
INVALID_PARENT_TRANSACTION_STATUS.


PPRR
MERCHANT_NOT_REGISTERED.


PPS0
BANKAUTH_ROW_MISMATCH.


PPS1
BANKAUTH_ROW_SETTLED.


PPS2
BANKAUTH_ROW_VOIDED.


PPS3
BANKAUTH_EXPIRED.


PPS4
CURRENCY_MISMATCH.


PPS5
CREDITCARD_MISMATCH.


PPS6
AMOUNT_MISMATCH.


PPSC
ARC_SCORE.


PPSD
STATUS_DESCRIPTION.


PPSE
AMEX_DENIED.


PPTE
VERIFICATION_TOKEN_EXPIRED.


PPTF
INVALID_TRACE_REFERENCE.


PPTI
INVALID_TRANSACTION_ID.


PPTR
VERIFICATION_TOKEN_REVOKED.


PPTT
TRANSACTION_TYPE_UNSUPPORTED.


PPTV
INVALID_VERIFICATION_TOKEN.


PPUA
USER_NOT_AUTHORIZED.


PPUC
CURRENCY_CODE_UNSUPPORTED.


PPUE
UNSUPPORT_ENTITY.


PPUI
UNSUPPORT_INSTALLMENT.


PPUP
UNSUPPORT_POS_FLAG.


PPUR
UNSUPPORTED_REVERSAL.


PPVC
VALIDATE_CURRENCY.


PPVE
VALIDATION_ERROR.


PPVT
VIRTUAL_TERMINAL_UNSUPPORTED.


 
payment_advice_code
string
The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes.


 Enum Value Description
21
For Mastercard, the card holder has been unsuccessful at canceling recurring payment through merchant. Stop recurring payment requests. For Visa, all recurring payments were canceled for the card number requested. Stop recurring payment requests.


22
For Mastercard, merchant does not qualify for product code.


24
For Mastercard, retry after 1 hour.


25
For Mastercard, retry after 24 hours.


26
For Mastercard, retry after 2 days.


27
For Mastercard, retry after 4 days.


28
For Mastercard, retry after 6 days.


29
For Mastercard, retry after 8 days.


30
For Mastercard, retry after 10 days .


40
For Mastercard, consumer non-reloadable prepaid card.


43
For Mastercard, consumer multi-use virtual card number.


01
For Mastercard, expired card account upgrade or portfolio sale conversion. Obtain new account information before next billing cycle.


02
For Mastercard, over credit limit or insufficient funds. Retry the transaction 72 hours later. For Visa, the card holder wants to stop only one specific payment in the recurring payment relationship. The merchant must NOT resubmit the same transaction. The merchant can continue the billing process in the subsequent billing period.


03
For Mastercard, account closed as fraudulent. Obtain another type of payment from customer due to account being closed or fraud. Possible reason: Account closed as fraudulent. For Visa, the card holder wants to stop all recurring payment transactions for a specific merchant. Stop recurring payment requests.


04
For Mastercard, token requirements not fulfilled for this token type.


 
{
  • "avs_code": "A",
  • "cvv_code": "E",
  • "response_code": "0000",
  • "payment_advice_code": "01"
}
Purchase Unit
The purchase unit details. Used to capture required information for the payment contract.


reference_id
string  [ 1 .. 256 ] characters 
The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through PATCH. If you omit this value and the order contains only one purchase unit, PayPal sets this value to default. 
Note: If there are multiple purchase units, reference_id is required for each purchase unit.


 
description
string  [ 1 .. 127 ] characters 
The purchase description.


 
custom_id
string  [ 1 .. 255 ] characters 
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.


 
invoice_id
string  [ 1 .. 127 ] characters 
The API caller-provided external invoice ID for this order.


 
id
string  [ 1 .. 19 ] characters 
The PayPal-generated ID for the purchase unit. This ID appears in both the payer's transaction history and the emails that the payer receives. In addition, this ID is available in transaction and settlement reports that merchants and API callers can use to reconcile transactions. This ID is only available when an order is saved by calling v2/checkout/orders/id/save.


 
soft_descriptor
string  [ 1 .. 22 ] characters 
The payment descriptor on account transactions on the customer's credit card statement, that PayPal sends to processors. The maximum length of the soft descriptor information that you can pass in the API field is 22 characters, in the following format:22 - len(PAYPAL * (8)) - len(Descriptor in Payment Receiving Preferences of Merchant account + 1)The PAYPAL prefix uses 8 characters.

The soft descriptor supports the following ASCII characters:
  • Alphanumeric characters
  • Dashes
  • Asterisks
  • Periods (.)
  • Spaces
For Wallet payments marketplace integrations:
  • The merchant descriptor in the Payment Receiving Preferences must be the marketplace name.
  • You can't use the remaining space to show the customer service number.
  • The remaining spaces can be a combination of seller name and country.

For unbranded payments (Direct Card) marketplace integrations, use a combination of the seller name and phone number.


 
Array of objects (item) 
An array of items that the customer purchases from the merchant.


 
most_recent_errors
Array of any  [ 1 .. 10 ] items 
The error reason code and description that are the reason for the most recent order decline.


 
object (amount_with_breakdown) 
The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
If you specify amount.breakdown, the amount equals item_total plus tax_total plus shipping plus handling plus insurance minus shipping_discount minus discount.
The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.


 
object (payee) 
The merchant who receives payment for this transaction.


 
object (payment_instruction) 
Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.


 
object (shipping_with_tracking_details) 
The shipping address and method.


 
object (supplementary_data) 
Supplementary data about this payment. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.


 
object (Payment Collection) 
The comprehensive history of payments for the purchase unit.


 
{
  • "reference_id": "string",
  • "description": "string",
  • "custom_id": "string",
  • "invoice_id": "string",
  • "id": "string",
  • "soft_descriptor": "string",
  • "items": [
    • {
      • "name": "string",
      • "quantity": "string",
      • "description": "string",
      • "sku": "string",
      • "url": "http://example.com",
      • "category": "DIGITAL_GOODS",
      • "image_url": "http://example.com",
      • "unit_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "tax": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "upc": {
        • "type": "UPC-A",
        • "code": "string"
        },
      • "billing_plan": {
        • "billing_cycles": [
          • {
            • "tenure_type": "REGULAR",
            • "total_cycles": 1,
            • "sequence": 1,
            • "pricing_scheme": {
              • "pricing_model": "FIXED",
              • "price": {
                • "currency_code": null,
                • "value": null
                },
              • "reload_threshold_amount": {
                • "currency_code": null,
                • "value": null
                }
              },
            • "start_date": "string"
            }
          ],
        • "name": "string",
        • "setup_fee": {
          • "currency_code": "str",
          • "value": "string"
          }
        }
      }
    ],
  • "most_recent_errors": [
    • null
    ],
  • "amount": {
    • "currency_code": "str",
    • "value": "string",
    • "breakdown": {
      • "item_total": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "shipping": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "handling": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "tax_total": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "insurance": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "shipping_discount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "discount": {
        • "currency_code": "str",
        • "value": "string"
        }
      }
    },
  • "payee": {
    • "email_address": "string",
    • "merchant_id": "string"
    },
  • "payment_instruction": {
    • "platform_fees": [
      • {
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "payee": {
          • "email_address": "string",
          • "merchant_id": "string"
          }
        }
      ],
    • "payee_pricing_tier_id": "string",
    • "payee_receivable_fx_rate_id": "string",
    • "disbursement_mode": "INSTANT"
    },
  • "shipping": {
    • "type": "SHIPPING",
    • "options": [
      • {
        • "id": "string",
        • "label": "string",
        • "selected": true,
        • "type": "SHIPPING",
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          }
        }
      ],
    • "name": {
      • "full_name": "string"
      },
    • "email_address": "string",
    • "phone_number": {
      • "country_code": "str",
      • "national_number": "string"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      },
    • "trackers": [
      • {
        • "id": "string",
        • "status": "CANCELLED",
        • "items": [],
        • "links": [
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "GET"
            }
          ],
        • "create_time": "string",
        • "update_time": "string"
        }
      ]
    },
  • "supplementary_data": {
    • "card": {
      • "level_2": {
        • "invoice_id": "string",
        • "tax_total": {
          • "currency_code": "str",
          • "value": "string"
          }
        },
      • "level_3": {
        • "ships_from_postal_code": "string",
        • "line_items": [
          • {
            • "name": "string",
            • "quantity": "string",
            • "description": "string",
            • "sku": "string",
            • "url": "http://example.com",
            • "image_url": "http://example.com",
            • "upc": {
              • "type": "UPC-A",
              • "code": "string"
              },
            • "billing_plan": {
              • "billing_cycles": [
                • null
                ],
              • "name": "string",
              • "setup_fee": {
                • "currency_code": null,
                • "value": null
                }
              },
            • "commodity_code": "string",
            • "unit_of_measure": "string",
            • "unit_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "tax": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "discount_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "total_amount": {
              • "currency_code": "str",
              • "value": "string"
              }
            }
          ],
        • "shipping_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "duty_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "discount_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "shipping_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        }
      },
    • "risk": {
      • "customer": {
        • "ip_address": "string"
        }
      }
    },
  • "payments": {
    • "authorizations": [
      • {
        • "status": "CREATED",
        • "status_details": {
          • "reason": "PENDING_REVIEW"
          },
        • "id": "string",
        • "invoice_id": "string",
        • "custom_id": "string",
        • "links": [
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "GET"
            }
          ],
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          },
        • "seller_protection": {
          • "status": "ELIGIBLE",
          • "dispute_categories": [
            • "string"
            ]
          },
        • "expiration_time": "string",
        • "create_time": "string",
        • "update_time": "string",
        • "processor_response": {
          • "avs_code": "A",
          • "cvv_code": "E",
          • "response_code": "0000",
          • "payment_advice_code": "01"
          }
        }
      ],
    • "captures": [
      • {
        • "create_time": "string",
        • "update_time": "string",
        • "id": "string",
        • "invoice_id": "string",
        • "custom_id": "string",
        • "final_capture": false,
        • "links": [
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "GET"
            }
          ],
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "acquirer_reference_number": "string",
          • "network": "VISA"
          },
        • "seller_protection": {
          • "status": "ELIGIBLE",
          • "dispute_categories": [
            • "string"
            ]
          },
        • "seller_receivable_breakdown": {
          • "platform_fees": [
            • {
              • "amount": {
                • "currency_code": null,
                • "value": null
                },
              • "payee": {
                • "email_address": null,
                • "merchant_id": null
                }
              }
            ],
          • "gross_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "paypal_fee": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "paypal_fee_in_receivable_currency": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "net_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "receivable_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "exchange_rate": {
            • "value": "string",
            • "source_currency": "str",
            • "target_currency": "str"
            }
          },
        • "disbursement_mode": "INSTANT",
        • "processor_response": {
          • "avs_code": "A",
          • "cvv_code": "E",
          • "response_code": "0000",
          • "payment_advice_code": "01"
          }
        }
      ],
    • "refunds": [
      • {
        • "status": "CANCELLED",
        • "status_details": {
          • "reason": "ECHECK"
          },
        • "id": "string",
        • "invoice_id": "string",
        • "custom_id": "string",
        • "acquirer_reference_number": "string",
        • "note_to_payer": "string",
        • "seller_payable_breakdown": {
          • "platform_fees": [
            • {
              • "amount": {
                • "currency_code": null,
                • "value": null
                },
              • "payee": {
                • "email_address": null,
                • "merchant_id": null
                }
              }
            ],
          • "net_amount_breakdown": [
            • {
              • "payable_amount": {
                • "currency_code": null,
                • "value": null
                },
              • "converted_amount": {
                • "currency_code": null,
                • "value": null
                },
              • "exchange_rate": {
                • "value": null,
                • "source_currency": null,
                • "target_currency": null
                }
              }
            ],
          • "gross_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "paypal_fee": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "paypal_fee_in_receivable_currency": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "net_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "net_amount_in_receivable_currency": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "total_refunded_amount": {
            • "currency_code": "str",
            • "value": "string"
            }
          },
        • "links": [
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "GET"
            }
          ],
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "payer": {
          • "email_address": "string",
          • "merchant_id": "string"
          },
        • "create_time": "string",
        • "update_time": "string"
        }
      ]
    }
}
Purchase Unit Request
The purchase unit request. Includes required information for the payment contract.


reference_id
string  [ 1 .. 256 ] characters 
The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through PATCH. If you omit this value and the order contains only one purchase unit, PayPal sets this value to default.


 
description
string  [ 1 .. 127 ] characters 
The purchase description. The maximum length of the character is dependent on the type of characters used. The character length is specified assuming a US ASCII character. Depending on type of character; (e.g. accented character, Japanese characters) the number of characters that that can be specified as input might not equal the permissible max length.


 
custom_id
string  [ 1 .. 255 ] characters 
The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer.


 
invoice_id
string  [ 1 .. 127 ] characters 
The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.


 
soft_descriptor
string  [ 1 .. 22 ] characters 
The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a payer's card statement.

If an Order is paid using the "PayPal Wallet", the statement descriptor will appear in following format on the payer's card statement: PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptor
Note: The merchant descriptor is the descriptor of the merchant’s payment receiving preferences which can be seen by logging into the merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/edit
The PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the statement. 
For example, if:
  • The PayPal prefix toggle is PAYPAL *.
  • The merchant descriptor in the profile is Janes Gift.
  • The soft descriptor is 800-123-1234.
Then, the statement descriptor on the card is PAYPAL * Janes Gift 80.


 
Array of objects (item) 
An array of items that the customer purchases from the merchant.


 
required
object (amount_with_breakdown) 
The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
If you specify amount.breakdown, the amount equals item_total plus tax_total plus shipping plus handling plus insurance minus shipping_discount minus discount.
The amount must be a positive number. The amount.value field supports up to 15 digits preceding the decimal. For a list of supported currencies, decimal precision, and maximum charge amount, see the PayPal REST APIs Currency Codes.


 
object (payee) 
The merchant who receives payment for this transaction.


 
object (payment_instruction) 
Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.


 
object (shipping_detail) 
The name and address of the person to whom to ship the items.


 
object (supplementary_data) 
Contains Supplementary Data.


 
{
  • "reference_id": "string",
  • "description": "string",
  • "custom_id": "string",
  • "invoice_id": "string",
  • "soft_descriptor": "string",
  • "items": [
    • {
      • "name": "string",
      • "quantity": "string",
      • "description": "string",
      • "sku": "string",
      • "url": "http://example.com",
      • "category": "DIGITAL_GOODS",
      • "image_url": "http://example.com",
      • "unit_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "tax": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "upc": {
        • "type": "UPC-A",
        • "code": "string"
        },
      • "billing_plan": {
        • "billing_cycles": [
          • {
            • "tenure_type": "REGULAR",
            • "total_cycles": 1,
            • "sequence": 1,
            • "pricing_scheme": {
              • "pricing_model": "FIXED",
              • "price": {
                • "currency_code": null,
                • "value": null
                },
              • "reload_threshold_amount": {
                • "currency_code": null,
                • "value": null
                }
              },
            • "start_date": "string"
            }
          ],
        • "name": "string",
        • "setup_fee": {
          • "currency_code": "str",
          • "value": "string"
          }
        }
      }
    ],
  • "amount": {
    • "currency_code": "str",
    • "value": "string",
    • "breakdown": {
      • "item_total": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "shipping": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "handling": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "tax_total": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "insurance": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "shipping_discount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "discount": {
        • "currency_code": "str",
        • "value": "string"
        }
      }
    },
  • "payee": {
    • "email_address": "string",
    • "merchant_id": "string"
    },
  • "payment_instruction": {
    • "platform_fees": [
      • {
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "payee": {
          • "email_address": "string",
          • "merchant_id": "string"
          }
        }
      ],
    • "payee_pricing_tier_id": "string",
    • "payee_receivable_fx_rate_id": "string",
    • "disbursement_mode": "INSTANT"
    },
  • "shipping": {
    • "type": "SHIPPING",
    • "options": [
      • {
        • "id": "string",
        • "label": "string",
        • "selected": true,
        • "type": "SHIPPING",
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          }
        }
      ],
    • "name": {
      • "full_name": "string"
      },
    • "email_address": "string",
    • "phone_number": {
      • "country_code": "str",
      • "national_number": "string"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st"
      }
    },
  • "supplementary_data": {
    • "card": {
      • "level_2": {
        • "invoice_id": "string",
        • "tax_total": {
          • "currency_code": "str",
          • "value": "string"
          }
        },
      • "level_3": {
        • "ships_from_postal_code": "string",
        • "line_items": [
          • {
            • "name": "string",
            • "quantity": "string",
            • "description": "string",
            • "sku": "string",
            • "url": "http://example.com",
            • "image_url": "http://example.com",
            • "upc": {
              • "type": "UPC-A",
              • "code": "string"
              },
            • "billing_plan": {
              • "billing_cycles": [
                • null
                ],
              • "name": "string",
              • "setup_fee": {
                • "currency_code": null,
                • "value": null
                }
              },
            • "commodity_code": "string",
            • "unit_of_measure": "string",
            • "unit_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "tax": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "discount_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "total_amount": {
              • "currency_code": "str",
              • "value": "string"
              }
            }
          ],
        • "shipping_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "duty_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "discount_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "shipping_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st"
          }
        }
      },
    • "risk": {
      • "customer": {
        • "ip_address": "string"
        }
      }
    }
}
refund
The refund information.


status
string (Refund Status With Details) 
The status of the refund.


 Enum Value Description
CANCELLED
The refund was cancelled.


FAILED
The refund could not be processed.


PENDING
The refund is pending. For more information, see status_details.reason.


COMPLETED
The funds for this transaction were debited to the customer's account.


 
object (refund_status_details) 
The details of the refund status.


 
id
string
The PayPal-generated ID for the refund.


 
invoice_id
string
The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.


 
custom_id
string  [ 1 .. 255 ] characters ^[A-Za-z0-9-_.,]*$
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.


 
acquirer_reference_number
string  [ 1 .. 36 ] characters ^[a-zA-Z0-9]+$
Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.


 
note_to_payer
string
The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.


 
object (Seller Payable Breakdown) 
The breakdown of the refund.


 
Array of objects (Link Description) 
An array of related HATEOAS links.


 
object (Money) 
The amount that the payee refunded to the payer.


 
object (payee_base) 
The details associated with the merchant for this transaction.


 
create_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction occurred, in Internet date and time format.


 
update_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction was last updated, in Internet date and time format.


 
{
  • "status": "CANCELLED",
  • "status_details": {
    • "reason": "ECHECK"
    },
  • "id": "string",
  • "invoice_id": "string",
  • "custom_id": "string",
  • "acquirer_reference_number": "string",
  • "note_to_payer": "string",
  • "seller_payable_breakdown": {
    • "platform_fees": [
      • {
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "payee": {
          • "email_address": "string",
          • "merchant_id": "string"
          }
        }
      ],
    • "net_amount_breakdown": [
      • {
        • "payable_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "converted_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "exchange_rate": {
          • "value": "string",
          • "source_currency": "str",
          • "target_currency": "str"
          }
        }
      ],
    • "gross_amount": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "paypal_fee": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "paypal_fee_in_receivable_currency": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "net_amount": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "net_amount_in_receivable_currency": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "total_refunded_amount": {
      • "currency_code": "str",
      • "value": "string"
      }
    },
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ],
  • "amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "payer": {
    • "email_address": "string",
    • "merchant_id": "string"
    },
  • "create_time": "string",
  • "update_time": "string"
}
refund_status
The refund status with details.


status
string (Refund Status With Details) 
The status of the refund.


 Enum Value Description
CANCELLED
The refund was cancelled.


FAILED
The refund could not be processed.


PENDING
The refund is pending. For more information, see status_details.reason.


COMPLETED
The funds for this transaction were debited to the customer's account.


 
object (refund_status_details) 
The details of the refund status.


 
{
  • "status": "CANCELLED",
  • "status_details": {
    • "reason": "ECHECK"
    }
}
refund_status_details
The details of the refund status.


reason
string (Refund Incomplete Reason) 
The reason why the refund has the PENDING or FAILED status.


 Value Description
ECHECK
The customer's account is funded through an eCheck, which has not yet cleared.


 
{
  • "reason": "ECHECK"
}
Risk Assessment Status
The risk assessment status.


string (Risk Assessment Status)   [ 1 .. 255 ] characters ^[A-Z_]+$
The risk assessment status.


 Enum Value Description
ALLOW
Fraud Protection allowed this payment.


DENY
Fraud Protection denied this payment.


PENDING
Payment is in Fraud Protection Review Queue.


 
"ALLOW"
risk_supplementary_data
Additional information necessary to evaluate the risk profile of a transaction.


object (participant_metadata) 
Profile information of the sender or receiver.


 
{
  • "customer": {
    • "ip_address": "string"
    }
}
Seller Receivable Breakdown
The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.


Array of objects (platform_fee)   [ 0 .. 1 ] items 
An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.


 
required
object (Money) 
The amount for this captured payment in the currency of the transaction.


 
object (Money) 
The applicable fee for this captured payment in the currency of the transaction.


 
object (Money) 
The applicable fee for this captured payment in the receivable currency. Returned only in cases the fee is charged in the receivable currency. Example 'CNY'.


 
object (Money) 
The net amount that the payee receives for this captured payment in their PayPal account. The net amount is computed as gross_amount minus the paypal_fee minus the platform_fees.


 
object (Money) 
The net amount that is credited to the payee's PayPal account. Returned only when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds. The amount is computed as net_amount times exchange_rate.


 
object (exchange_rate) 
The exchange rate that determines the amount that is credited to the payee's PayPal account. Returned when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds.


 
{
  • "platform_fees": [
    • {
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "payee": {
        • "email_address": "string",
        • "merchant_id": "string"
        }
      }
    ],
  • "gross_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "paypal_fee": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "paypal_fee_in_receivable_currency": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "net_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "receivable_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "exchange_rate": {
    • "value": "string",
    • "source_currency": "str",
    • "target_currency": "str"
    }
}
seller_protection
The level of protection offered as defined by PayPal Seller Protection for Merchants.


status
string (Seller Protection Status) 
Indicates whether the transaction is eligible for seller protection. For information, see PayPal Seller Protection for Merchants.


 Enum Value Description
ELIGIBLE
Your PayPal balance remains intact if the customer claims that they did not receive an item or the account holder claims that they did not authorize the payment.


PARTIALLY_ELIGIBLE
Your PayPal balance remains intact if the customer claims that they did not receive an item.


NOT_ELIGIBLE
This transaction is not eligible for seller protection.


 
dispute_categories
Array of strings
An array of conditions that are covered for the transaction.


 
{
  • "status": "ELIGIBLE",
  • "dispute_categories": [
    • "string"
    ]
}
Shipping Option and Amount data at Purchase Unit
This would contain shipping option and amount data at purchase unit level.


reference_id
string  [ 1 .. 256 ] characters ^.*$
The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through PATCH. If you omit this value and the order contains only one purchase unit, PayPal sets this value to default. 
Note: If there are multiple purchase units, reference_id is required for each purchase unit.


 
Array of objects (shipping_option)   [ 1 .. 10 ] items 
An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.


 
object (amount_with_breakdown) 
The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.


 
{
  • "reference_id": "string",
  • "shipping_options": [
    • {
      • "id": "string",
      • "label": "string",
      • "selected": true,
      • "type": "SHIPPING",
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        }
      }
    ],
  • "amount": {
    • "currency_code": "str",
    • "value": "string",
    • "breakdown": {
      • "item_total": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "shipping": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "handling": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "tax_total": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "insurance": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "shipping_discount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "discount": {
        • "currency_code": "str",
        • "value": "string"
        }
      }
    }
}
shipping_detail
The shipping details.


type
string (Fulfillment Type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either type or options may be present, but not both.


 Enum Value Description
SHIPPING
The payer intends to receive the items at a specified address.


PICKUP_IN_PERSON
DEPRECATED. Please use "PICKUP_FROM_PERSON" instead.


PICKUP_IN_STORE
The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option.


PICKUP_FROM_PERSON
The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment.


 
Array of objects (shipping_option)   [ 0 .. 10 ] items 
An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.


 
object (Name) 
The name of the person to whom to ship the items. Supports only the full_name property.


 
email_address
string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.


 
object (Phone) 
The phone number of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. [Format - canonical international E.164 numbering plan]


 
object (Portable Postal Address (Medium-Grained)) 
The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. admin_area_1 is required for addresses located in Argentina, Brazil, China, Canada, India, Indonesia, Japan, Mexico, Thailand, and the United States.


 
{
  • "type": "SHIPPING",
  • "options": [
    • {
      • "id": "string",
      • "label": "string",
      • "selected": true,
      • "type": "SHIPPING",
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        }
      }
    ],
  • "name": {
    • "full_name": "string"
    },
  • "email_address": "string",
  • "phone_number": {
    • "country_code": "str",
    • "national_number": "string"
    },
  • "address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    }
}
shipping_detail
The shipping details.


type
string (Fulfillment Type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either type or options may be present, but not both.


 Enum Value Description
SHIPPING
The payer intends to receive the items at a specified address.


PICKUP_IN_PERSON
DEPRECATED. Please use "PICKUP_FROM_PERSON" instead.


PICKUP_IN_STORE
The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option.


PICKUP_FROM_PERSON
The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment.


 
object (Name) 
The name of the person to whom to ship the items. Supports only the full_name property.


 
email_address
string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.


 
object (Phone) 
The phone number of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. [Format - canonical international E.164 numbering plan]


 
object (Portable Postal Address (Medium-Grained)) 
The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. admin_area_1 is required for addresses located in Argentina, Brazil, China, Canada, India, Indonesia, Japan, Mexico, Thailand, and the United States.


 
{
  • "type": "SHIPPING",
  • "name": {
    • "full_name": "string"
    },
  • "email_address": "string",
  • "phone_number": {
    • "country_code": "str",
    • "national_number": "string"
    },
  • "address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    }
}
shipping_option
The options that the payee or merchant offers to the payer to ship or pick up their items.


id
required
string  <= 127 characters 
A unique ID that identifies a payer-selected shipping option.


 
label
required
string  <= 127 characters 
A description that the payer sees, which helps them choose an appropriate shipping option. For example, Free Shipping, USPS Priority Shipping, Expédition prioritaire USPS, or USPS yōuxiān fā huò. Localize this description to the payer's locale.


 
selected
required
boolean
If the API request sets selected = true, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the shipping.options in the PayPal Checkout experience. As part of the response if a shipping.option contains selected=true, it represents the shipping option that the payer selected during the course of checkout with PayPal. Only one shipping.option can be set to selected=true.


 
type
string (shipping_type) 
A classification for the method of purchase fulfillment.


 Enum Value Description
SHIPPING
The payer intends to receive the items at a specified address.


PICKUP
DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the items at a specified address (ie. a store address). 


PICKUP_IN_STORE
The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option.


PICKUP_FROM_PERSON
The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment.


 
object (Money) 
The shipping cost for the selected option.


 
{
  • "id": "string",
  • "label": "string",
  • "selected": true,
  • "type": "SHIPPING",
  • "amount": {
    • "currency_code": "str",
    • "value": "string"
    }
}
shipping_option
The options that the payee or merchant offers to the payer to ship or pick up their items.


id
required
string  <= 127 characters 
A unique ID that identifies a payer-selected shipping option.


 
label
required
string  <= 127 characters 
A description that the payer sees, which helps them choose an appropriate shipping option. For example, Free Shipping, USPS Priority Shipping, Expédition prioritaire USPS, or USPS yōuxiān fā huò. Localize this description to the payer's locale.


 
type
string (shipping_type) 
A classification for the method of purchase fulfillment.


 Enum Value Description
SHIPPING
The payer intends to receive the items at a specified address.


PICKUP
DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the items at a specified address (ie. a store address). 


PICKUP_IN_STORE
The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option.


PICKUP_FROM_PERSON
The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment.


 
object (Money) 
The shipping cost for the selected option.


 
{
  • "id": "string",
  • "label": "string",
  • "type": "SHIPPING",
  • "amount": {
    • "currency_code": "str",
    • "value": "string"
    }
}
shipping_type
A classification for the method of purchase fulfillment.


string (shipping_type) 
A classification for the method of purchase fulfillment.


 Enum Value Description
SHIPPING
The payer intends to receive the items at a specified address.


PICKUP
DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the items at a specified address (ie. a store address). 


PICKUP_IN_STORE
The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option.


PICKUP_FROM_PERSON
The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment.


 
"SHIPPING"
shipping_with_tracking_details
The order shipping details.


type
string (Fulfillment Type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either type or options may be present, but not both.


 Enum Value Description
SHIPPING
The payer intends to receive the items at a specified address.


PICKUP_IN_PERSON
DEPRECATED. Please use "PICKUP_FROM_PERSON" instead.


PICKUP_IN_STORE
The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option.


PICKUP_FROM_PERSON
The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment.


 
Array of objects (shipping_option)   [ 0 .. 10 ] items 
An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.


 
object (Name) 
The name of the person to whom to ship the items. Supports only the full_name property.


 
email_address
string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.


 
object (Phone) 
The phone number of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. [Format - canonical international E.164 numbering plan]


 
object (Portable Postal Address (Medium-Grained)) 
The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. admin_area_1 is required for addresses located in Argentina, Brazil, China, Canada, India, Indonesia, Japan, Mexico, Thailand, and the United States.


 
Array of objects (tracker) 
An array of trackers for a transaction.


 
{
  • "type": "SHIPPING",
  • "options": [
    • {
      • "id": "string",
      • "label": "string",
      • "selected": true,
      • "type": "SHIPPING",
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        }
      }
    ],
  • "name": {
    • "full_name": "string"
    },
  • "email_address": "string",
  • "phone_number": {
    • "country_code": "str",
    • "national_number": "string"
    },
  • "address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    },
  • "trackers": [
    • {
      • "id": "string",
      • "status": "CANCELLED",
      • "items": [],
      • "links": [
        • {
          • "href": "string",
          • "rel": "string",
          • "method": "GET"
          }
        ],
      • "create_time": "string",
      • "update_time": "string"
      }
    ]
}
single_use_token
The PayPal-generated, short-lived, one-time-use token, used to communicate payment information to PayPal for transaction processing.


string (single_use_token)   [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated, short-lived, one-time-use token, used to communicate payment information to PayPal for transaction processing.


 
"string"
sofort
Information used to pay using Sofort.


name
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The bank identification code (BIC).


 
iban_last_chars
string (iban_last_chars)   [ 4 .. 34 ] characters [a-zA-Z0-9]{4}
The last characters of the IBAN used to pay.


 
{
  • "name": "string",
  • "country_code": "string",
  • "bic": "string",
  • "iban_last_chars": "string"
}
sofort_request
Information needed to pay using Sofort.


name
required
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "experience_context": {
    • "brand_name": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "locale": "string",
    • "return_url": "string",
    • "cancel_url": "string"
    }
}
store_in_vault_instruction
Defines how and when the payment source gets vaulted.


string (store_in_vault_instruction)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Defines how and when the payment source gets vaulted.


 Value Description
ON_SUCCESS
Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful.


 
"ON_SUCCESS"
stored_payment_source
Provides additional details to process a payment using a payment_source that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
  • payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
  • usage=FIRST is compatible only with payment_initiator=CUSTOMER.
  • previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
  • Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.


payment_initiator
required
string (payment_initiator)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The person or party who initiated or triggered the payment.


 Enum Value Description
CUSTOMER
Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website.


MERCHANT
Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer.


 
payment_type
required
string (stored_payment_source_payment_type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Indicates the type of the stored payment_source payment.


 Enum Value Description
ONE_TIME
One Time payment such as online purchase or donation. (e.g. Checkout with one-click).


RECURRING
Payment which is part of a series of payments with fixed or variable amounts, following a fixed time interval. (e.g. Subscription payments).


UNSCHEDULED
Payment which is part of a series of payments that occur on a non-fixed schedule and/or have variable amounts. (e.g. Account Topup payments).


 
usage
string (stored_payment_source_usage_type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
 Default:  "DERIVED"
Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).


 Enum Value Description
FIRST
Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment.


SUBSEQUENT
Indicates a payment using a stored payment_source which has been successfully used previously for a payment.


DERIVED
Indicates that PayPal will derive the value of FIRST or SUBSEQUENT based on data available to PayPal.


 
object (network_transaction_reference) 
Reference values used by the card network to identify a transaction.


 
{
  • "payment_initiator": "CUSTOMER",
  • "payment_type": "ONE_TIME",
  • "usage": "FIRST",
  • "previous_network_transaction_reference": {
    • "id": "stringstr",
    • "date": "stri",
    • "acquirer_reference_number": "string",
    • "network": "VISA"
    }
}
stored_payment_source_payment_type
Indicates the type of the stored payment_source payment.


string (stored_payment_source_payment_type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Indicates the type of the stored payment_source payment.


 Enum Value Description
ONE_TIME
One Time payment such as online purchase or donation. (e.g. Checkout with one-click).


RECURRING
Payment which is part of a series of payments with fixed or variable amounts, following a fixed time interval. (e.g. Subscription payments).


UNSCHEDULED
Payment which is part of a series of payments that occur on a non-fixed schedule and/or have variable amounts. (e.g. Account Topup payments).


 
"ONE_TIME"
stored_payment_source_usage_type
Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).


string (stored_payment_source_usage_type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
 Default:  "DERIVED"
Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).


 Enum Value Description
FIRST
Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment.


SUBSEQUENT
Indicates a payment using a stored payment_source which has been successfully used previously for a payment.


DERIVED
Indicates that PayPal will derive the value of FIRST or SUBSEQUENT based on data available to PayPal.


 
"FIRST"
Subscription period
Describes a period in a subscription. A period is a chunk of time for which a set of subscription terms are applicable.


current_period
boolean
Indicates if this period, with its subscription terms, is currently active.


 
billing_interval_unit
string  [ 1 .. 24 ] characters ^[A-Z_]+$
The billing interval unit for the subscription period.


 Enum Value Description
YEAR
The billing interval for the subscription period is a year.


MONTH
The billing interval for the subscription period is a month.


SEMIMONTH
The billing interval for the subscription period is half a month.


WEEK
The billing interval for the subscription period is a week.


DAY
The billing interval for the subscription period is a day.


 
billing_frequency
integer  [ 1 .. 365 ] 
 Default:  1
The frequency, i.e. the number of billing interval units, at which the subscriber is charged. E.g. - if the billing_interval_unit is DAY, with a billing_frequency of 2, the subscriber is billed once every two days.


 
total_billing_cycles
integer  [ 0 .. 999 ] 
 Default:  1
The number of billing cycles in the period. This is effectively the number of times the subscriber will be charged in the period.


 
current_billing_cycle
integer  [ 0 .. 999 ] 
Indicates the index of the current billing cycle for the period. E.g. - a value of 3 would mean that its the third billing cycle for the period.


 
regular_period
boolean
Indicates if the period is a regular period. A regular period would have standard subscription terms, as opposed to some special terms that might be applicable for a trial or promotional period.


 
object (Money) 
The amount that the subscriber will be charged in each billing cycle.


 
object (Money) 
The shipping charges applicable for each cycle.


 
object (Money) 
The tax amount applicable for each cycle.


 
{
  • "current_period": true,
  • "billing_interval_unit": "YEAR",
  • "billing_frequency": 1,
  • "total_billing_cycles": 1,
  • "current_billing_cycle": 999,
  • "regular_period": true,
  • "billing_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "shipping_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "tax_amount": {
    • "currency_code": "str",
    • "value": "string"
    }
}
supplementary_data
Supplementary data about a payment. This object passes information that can be used to improve risk assessments and processing costs, for example, by providing Level 2 and Level 3 payment data.


object (card_supplementary_data) 
Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.


 
object (risk_supplementary_data) 
Merchants and partners can add additional customer parameters that can help with better fraud protection and reduced risk for unbranded card payments.


 
{
  • "card": {
    • "level_2": {
      • "invoice_id": "string",
      • "tax_total": {
        • "currency_code": "str",
        • "value": "string"
        }
      },
    • "level_3": {
      • "ships_from_postal_code": "string",
      • "line_items": [
        • {
          • "name": "string",
          • "quantity": "string",
          • "description": "string",
          • "sku": "string",
          • "url": "http://example.com",
          • "image_url": "http://example.com",
          • "upc": {
            • "type": "UPC-A",
            • "code": "string"
            },
          • "billing_plan": {
            • "billing_cycles": [
              • {
                • "tenure_type": null,
                • "total_cycles": null,
                • "sequence": null,
                • "pricing_scheme": null,
                • "start_date": null
                }
              ],
            • "name": "string",
            • "setup_fee": {
              • "currency_code": "str",
              • "value": "string"
              }
            },
          • "commodity_code": "string",
          • "unit_of_measure": "string",
          • "unit_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "discount_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "total_amount": {
            • "currency_code": "str",
            • "value": "string"
            }
          }
        ],
      • "shipping_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "duty_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "discount_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "shipping_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st"
        }
      }
    },
  • "risk": {
    • "customer": {
      • "ip_address": "string"
      }
    }
}
tax_info
The tax ID of the customer. The customer is also known as the payer. Both tax_id and tax_id_type are required.


tax_id
required
string  [ 1 .. 14 ] characters ([a-zA-Z0-9])
The customer's tax ID value.


 
tax_id_type
required
string  [ 1 .. 14 ] characters ^[A-Z0-9_]+$
The customer's tax ID type.


 Enum Value Description
BR_CPF
The individual tax ID type, typically is 11 characters long.


BR_CNPJ
The business tax ID type, typically is 14 characters long.


 
{
  • "tax_id": "string",
  • "tax_id_type": "BR_CPF"
}
three_d_secure_authentication_response
Results of 3D Secure Authentication.


authentication_status
string (pares_status)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The outcome of the issuer's authentication.


 Enum Value Description
Y
Successful authentication.


N
Failed authentication / account not verified / transaction denied.


U
Unable to complete authentication.


A
Successful attempts transaction.


C
Challenge required for authentication.


R
Authentication rejected (merchant must not submit for authorization).


D
Challenge required; decoupled authentication confirmed.


I
Informational only; 3DS requestor challenge preference acknowledged.


 
enrollment_status
string (enrolled)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Status of authentication eligibility.


 Enum Value Description
Y
Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl.


N
No. The bank is not participating in 3-D Secure protocol.


U
Unavailable. The DS or ACS is not available for authentication at the time of the request.


B
Bypass. The merchant authentication rule is triggered to bypass authentication.


 
{
  • "authentication_status": "Y",
  • "enrollment_status": "Y"
}
token
The tokenized payment source to fund a payment.


id
required
string  [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the token.


 
type
required
string  [ 1 .. 255 ] characters ^[0-9A-Z_-]+$
The tokenization method that generated the ID.


 Value Description
BILLING_AGREEMENT
The PayPal billing agreement ID. References an approved recurring payment for goods or services.


 
{
  • "id": "string",
  • "type": "BILLING_AGREEMENT"
}
tracker
The tracking response on creation of tracker.


id
string
The tracker id.


 
status
string (Tracker Status)   [ 1 .. 64 ] characters ^[0-9A-Z_]+$
The status of the item shipment.


 Enum Value Description
CANCELLED
The shipment was cancelled and the tracking number no longer applies.


SHIPPED
The merchant has assigned a tracking number to the items being shipped from the Order. This does not correspond to the carrier's actual status for the shipment. The latest status of the parcel must be retrieved from the carrier.


 
Array of objects (tracker_item) 
An array of details of items in the shipment.


 
Array of objects (Link Description) 
An array of request-related HATEOAS links.


 
create_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction occurred, in Internet date and time format.


 
update_time
string <ppaas_date_time_v3>  (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
The date and time when the transaction was last updated, in Internet date and time format.


 
{
  • "id": "string",
  • "status": "CANCELLED",
  • "items": [],
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ],
  • "create_time": "string",
  • "update_time": "string"
}
tracker
The tracking information for a shipment.


tracking_number
required
string  [ 1 .. 64 ] characters 
The tracking number for the shipment. This property supports Unicode.


 
carrier_name_other
string  [ 1 .. 64 ] characters 
The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.


 
carrier
required
string (carrier)   [ 1 .. 64 ] characters ^[0-9A-Z_]+$
The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier to OTHER and set carrier name in carrier_name_other. For allowed values, see Carriers.


 Enum Value Description
DPD_RU
DPD Russia.


BG_BULGARIAN_POST
Bulgarian Posts.


KR_KOREA_POST
Koreapost (www.koreapost.go.kr).


ZA_COURIERIT
Courier IT.


FR_EXAPAQ
DPD France (formerly exapaq).


ARE_EMIRATES_POST
Emirates Post.


GAC
GAC.


GEIS
Geis CZ.


SF_EX
SF Express.


PAGO
Pago Logistics.


MYHERMES
MyHermes UK.


DIAMOND_EUROGISTICS
Diamond Eurogistics Limited.


CORPORATECOURIERS_WEBHOOK
Corporate Couriers.


BOND
Bond courier.


OMNIPARCEL
Omni Parcel.


SK_POSTA
Slovenska pošta.


PUROLATOR
purolator.


FETCHR_WEBHOOK
Mena 360 (Fetchr).


THEDELIVERYGROUP
TDG – The Delivery Group.


CELLO_SQUARE
Cello Square.


TARRIVE
TONDA GLOBAL.


COLLIVERY
MDS Collivery Pty (Ltd).


MAINFREIGHT
Mainfreight.


IND_FIRSTFLIGHT
First Flight Couriers.


ACSWORLDWIDE
ACS Worldwide Express.


AMSTAN
Amstan Logistics.


OKAYPARCEL
OkayParcel.


ENVIALIA_REFERENCE
Envialia Reference.


SEUR_ES
Seur Spain.


CONTINENTAL
Continental.


FDSEXPRESS
FDSEXPRESS.


AMAZON_FBA_SWISHIP
Swiship UK.


WYNGS
Wyngs.


DHL_ACTIVE_TRACING
DHL Active Tracing.


ZYLLEM
Zyllem.


RUSTON
Ruston.


XPOST
Xpost.ph.


CORREOS_ES
correos Express (www.correos.es).


DHL_FR
DHL France (www.dhl.com).


PAN_ASIA
Pan-Asia International.


BRT_IT
BRT couriers Italy (www.brt.it).


SRE_KOREA
SRE Korea (www.srekorea.co.kr).


SPEEDEE
Spee-Dee Delivery.


TNT_UK
TNT UK Limited (www.tnt.com).


VENIPAK
Venipak.


SHREENANDANCOURIER
SHREE NANDAN COURIER.


CROSHOT
Croshot.


NIPOST_NG
NIpost (www.nipost.gov.ng).


EPST_GLBL
ePost Global.


NEWGISTICS
Newgistics.


POST_SLOVENIA
Post of Slovenia.


JERSEY_POST
Jersey Post.


BOMBINOEXP
Bombino Express Pvt.


WMG
WMG Delivery.


XQ_EXPRESS
XQ Express.


FURDECO
Furdeco.


LHT_EXPRESS
LHT Express.


SOUTH_AFRICAN_POST_OFFICE
South African Post Office.


SPOTON
SPOTON Logistics Pvt Ltd.


DIMERCO
Dimerco Express Group.


CYPRUS_POST_CYP
cyprus post.


ABCUSTOM
AB Custom Group.


IND_DELIVREE
deliverE.


CN_BESTEXPRESS
Best Express.


DX_SFTP
DX (SFTP).


PICKUPP_MYS
PICK UPP.


FMX
FMX.


HELLMANN
Hellmann Worldwide Logistics.


SHIP_IT_ASIA
Ship It Asia.


KERRY_ECOMMERCE
Kerry eCommerce.


FRETERAPIDO
Frete Rapido.


PITNEY_BOWES
Pitney Bowes.


XPRESSEN_DK
Xpressen courier.


SEUR_SP_API
Spanish Seur API.


DELIVERYONTIME
DELIVERYONTIME LOGISTICS PVT LTD.


JINSUNG
JINSUNG TRADING.


TRANS_KARGO
Trans Kargo Internasional.


SWISHIP_DE
Swiship DE.


IVOY_WEBHOOK
Ivoy courier.


AIRMEE_WEBHOOK
Airmee couriers.


DHL_BENELUX
dhl benelux.


FIRSTMILE
FirstMile.


FASTWAY_IR
Fastway Ireland.


HH_EXP
Hua Han Logistics.


MYS_MYPOST_ONLINE
Mypostonline.


TNT_NL
THT Netherland.


TIPSA
TIPSA courier.


TAQBIN_MY
TAQBIN Malaysia.


KGMHUB
KGM Hub.


INTEXPRESS
Internet Express.


OVERSE_EXP
Overseas Express.


ONECLICK
One click delivery services.


ROADRUNNER_FREIGHT
Roadbull Logistics.


GLS_CROTIA
GLS Croatia.


MRW_FTP
MRW courier.


BLUEX
Blue Express.


DYLT
Daylight Transport.


DPD_IR
DPD Ireland.


SIN_GLBL
Sin Global Express.


TUFFNELLS_REFERENCE
Tuffnells Parcels Express- Reference.


CJPACKET
CJ Packet.


MILKMAN
Milkman courier.


ASIGNA
ASIGNA courier.


ONEWORLDEXPRESS
One World Express.


ROYAL_MAIL
RoyalShipments.


VIA_EXPRESS
Viaxpress.


TIGFREIGHT
TIG Freight.


ZTO_EXPRESS
ZTO Express.


TWO_GO
2GO Courier.


IML
IML courier.


INTEL_VALLEY
Intel-Valley Supply chain (ShenZhen) Co. Ltd.


EFS
EFS (E-commerce Fulfillment Service).


UK_UK_MAIL
UK mail (ukmail.com).


RAM
RAM courier.


ALLIEDEXPRESS
Allied Express.


APC_OVERNIGHT
APC overnight (apc-overnight.com).


SHIPPIT
Shippit.


TFM
TFM Xpress.


M_XPRESS
M Xpress Sdn Bhd.


HDB_BOX
Haidaibao (BOX).


CLEVY_LINKS
Clevy Links.


IBEONE
Beone Logistics.


FIEGE_NL
Fiege Netherlands.


KWE_GLOBAL
KWE Global.


CTC_EXPRESS
CTC Express.


AMAZON
Amazon Shipping.


MORE_LINK
Morelink.


JX
JX courier.


EASY_MAIL
Easy Mail.


ADUIEPYLE
A Duie Pyle.


GB_PANTHER
Panther.


EXPRESSSALE
Expresssale.


SG_DETRACK
Detrack.


TRUNKRS_WEBHOOK
Trunkrs courier.


MATDESPATCH
Matdespatch.


DICOM
GLS Logistic Systems Canada Ltd./Dicom.


MBW
MBW Courier Inc..


KHM_CAMBODIA_POST
Cambodia Post.


SINOTRANS
Sinotrans.


BRT_IT_PARCELID
BRT Bartolini(Parcel ID).


DHL_SUPPLY_CHAIN
DHL Supply Chain APAC.


DHL_PL
DHL Poland.


TOPYOU
TopYou.


PALEXPRESS
PAL Express Limited.


DHL_SG
dhl Singapore.


CN_WEDO
WeDo Logistics.


FULFILLME
Fulfillme.


DPD_DELISTRACK
DPD delistrack.


UPS_REFERENCE
UPS Reference.


CARIBOU
Caribou.


LOCUS_WEBHOOK
Locus courier.


DSV
DSV courier.


P2P_TRC
P2P TrakPak.


DIRECTPARCELS
Direct Parcels.


NOVA_POSHTA_INT
Nova Poshta (International).


FEDEX_POLAND
FedEx® Poland Domestic.


CN_JCEX
JCEX courier.


FAR_INTERNATIONAL
FAR international.


IDEXPRESS
IDEX courier.


GANGBAO
GANGBAO Supplychain.


NEWAY
Neway Transport.


POSTNL_INT_3_S
PostNL International.


RPX_ID
RPX Indonesia.


DESIGNERTRANSPORT_WEBHOOK
Designer Transport.


GLS_SLOVEN
GLS Slovenia.


PARCELLED_IN
Parcelled.in.


GSI_EXPRESS
GSI EXPRESS.


CON_WAY
Con-way Freight.


BROUWER_TRANSPORT
Brouwer Transport en Logistiek.


CPEX
Captain Express International.


ISRAEL_POST
Israel Post.


DTDC_IN
DTDC India.


PTT_POST
PTT Post.


XDE_WEBHOOK
Ximex Delivery Express.


TOLOS
Tolos courier.


GIAO_HANG
Giao hàng nhanh.


GEODIS_ESPACE
Geodis E-space.


MAGYAR_HU
Magyar Post.


DOORDASH_WEBHOOK
DoorDash.


TIKI_ID
Tiki shipment.


CJ_HK_INTERNATIONAL
CJ Logistics International(Hong Kong).


STAR_TRACK_EXPRESS
Star Track Express.


HELTHJEM
Helthjem.


SFB2C
SF International.


FREIGHTQUOTE
Freightquote by C.H. Robinson.


LANDMARK_GLOBAL_REFERENCE
Landmark Global Reference.


PARCEL2GO
Parcel2Go.


DELNEXT
Delnext.


RCL
Red Carpet Logistics.


CGS_EXPRESS
CGS Express.


HK_POST
Hongkong Post (www.hongkongpost.hk).


SAP_EXPRESS
SAP EXPRESS.


PARCELPOST_SG
Parcel Post Singapore.


HERMES
HermesWorld UK.


IND_SAFEEXPRESS
Safexpress.


TOPHATTEREXPRESS
Tophatter Express.


MGLOBAL
PT MGLOBAL LOGISTICS INDONESIA.


AVERITT
Averitt Express.


LEADER
leader.


_2EBOX
2ebox courier.


SG_SPEEDPOST
Singapore Speedpost.


DBSCHENKER_SE
DB Schenker (www.dbschenker.com).


ISR_POST_DOMESTIC
Israel Post Domestic.


BESTWAYPARCEL
Best Way Parcel.


ASENDIA_DE
asendia_de.


NIGHTLINE_UK
nightline_uk.


TAQBIN_SG
taqbin_sg.


TCK_EXPRESS
TCK Express.


ENDEAVOUR_DELIVERY
Endeavour Delivery.


NANJINGWOYUAN
Nanjing Woyuan.


HEPPNER_FR
Heppner France.


EMPS_CN
EMPS Express.


FONSEN
Fonsen Logistics.


PICKRR
Pickrr.


APC_OVERNIGHT_CONNUM
APC Overnight Consignment.


STAR_TRACK_NEXT_FLIGHT
Star Track Next Flight.


DAJIN
Shanghai Aqrum Chemical Logistics Co.Ltd.


UPS_FREIGHT
UPS Freight.


POSTA_PLUS
Posta Plus.


CEVA
CEVA LOGISTICS.


ANSERX
ANSERX courier.


JS_EXPRESS
JS EXPRESS.


PADTF
padtf.com.


UPS_MAIL_INNOVATIONS
UPS Mail Innovations.


SYPOST
Sunyou Post.


AMAZON_SHIP_MCF
Amazon Shipping + Amazon MCF.


YUSEN
Yusen Logistics.


BRING
Bring.


SDA_IT
SDA Italy.


GBA
GBA Services Ltd.


NEWEGGEXPRESS
Newegg Express.


SPEEDCOURIERS_GR
Speed Couriers.


FORRUN
forrun Pvt Ltd (Arpatech Venture).


PICKUP
Pickupp.


ECMS
ECMS International Logistics Co..


INTELIPOST
Intelipost (TMS for LATAM).


FLASHEXPRESS
Flash Express.


CN_STO
STO Express.


SEKO_SFTP
SEKO Worldwide.


HOME_DELIVERY_SOLUTIONS
Home Delivery Solutions Ltd.


DPD_HGRY
DPD Hungary.


KERRYTTC_VN
Kerry Express (Vietnam) Co Ltd.


JOYING_BOX
Joying Box.


TOTAL_EXPRESS
Total Express.


ZJS_EXPRESS
ZJS International.


STARKEN
STARKEN couriers.


DEMANDSHIP
DemandShip.


CN_DPEX
DPEX.


AUPOST_CN
AuPost China.


LOGISTERS
Logisters.


GOGLOBALPOST
Global Post.


GLS_CZ
GLS Czech Republic.


PAACK_WEBHOOK
Paack courier.


GRAB_WEBHOOK
Grab courier.


PARCELPOINT
Parcelpoint.


ICUMULUS
iCumulus.


DAIGLOBALTRACK
DAI Post.


GLOBAL_IPARCEL
i-parcel.


YURTICI_KARGO
Yurtici Kargo.


CN_PAYPAL_PACKAGE
PayPal Package.


PARCEL_2_POST
Parcel To Post.


GLS_IT
GLS Italy.


PIL_LOGISTICS
PIL Logistics (China) Co..


HEPPNER
Heppner Internationale Spedition GmbH & Co..


GENERAL_OVERNIGHT
Go!Express and logistics.


HAPPY2POINT
Happy 2ThePoint.


CHITCHATS
Chit Chats.


SMOOTH
Smooth Couriers.


CLE_LOGISTICS
CL E-Logistics Solutions Limited.


FIEGE
Fiege Logistics.


MX_CARGO
M&X cargo.


ZIINGFINALMILE
Ziing Final Mile Inc.


DAYTON_FREIGHT
Dayton Freight.


TCS
TCS courier.


AEX
AEX Group.


HERMES_DE
Hermes Germany.


ROUTIFIC_WEBHOOK
Routific.


GLOBAVEND
Globavend.


CJ_LOGISTICS
CJ Logistics International.


PALLET_NETWORK
The Pallet Network.


RAF_PH
RAF Philippines.


UK_XDP
XDP Express.


PAPER_EXPRESS
Paper Express.


LA_POSTE_SUIVI
La Poste.


PAQUETEXPRESS
Paquetexpress.


LIEFERY
liefery.


STRECK_TRANSPORT
Streck Transport.


PONY_EXPRESS
Pony express.


ALWAYS_EXPRESS
Always Express.


GBS_BROKER
GBS-Broker.


CITYLINK_MY
City-Link Express.


ALLJOY
ALLJOY SUPPLY CHAIN.


YODEL
yodel.


YODEL_DIR
Yodel Direct.


STONE3PL
STONE3PL.


PARCELPAL_WEBHOOK
ParcelPal.


DHL_ECOMERCE_ASA
DHL eCommerce Asia (API).


SIMPLYPOST
J&T Express Singapore.


KY_EXPRESS
Kua Yue Express.


SHENZHEN
shenzhen 1st International Logistics(Group)Co.


US_LASERSHIP
LaserShip.


UC_EXPRE
ucexpress.


DIDADI
DIDADI Logistics tech.


CJ_KR
CJ Korea Express.


DBSCHENKER_B2B
DB Schenker B2B.


MXE
MXE Express.


CAE_DELIVERS
CAE Delivers.


PFCEXPRESS
PFC Express.


WHISTL
Whistl.


WEPOST
WePost Sdn Bhd.


DHL_PARCEL_ES
DHL parcel Spain(www.dhl.com).


DDEXPRESS
DD Express Courier.


ARAMEX_AU
Aramex Australia (formerly Fastway AU).


BNEED
Bneed courier.


HK_TGX
Kerry Express Hong Kong.


LATVIJAS_PASTS
Latvijas Pasts.


VIAEUROPE
ViaEurope.


CORREO_UY
Correo Uruguayo.


CHRONOPOST_FR
Chronopost france (www.chronopost.fr).


J_NET
J-Net.


_6LS
6ls.com.


BLR_BELPOST
Belpost.


BIRDSYSTEM
BirdSystem.


DOBROPOST
DobroPost.


WAHANA_ID
Wahana express (www.wahana.com).


WEASHIP
Weaship.


SONICTL
Sonic Transportation & Logistics.


KWT
Shenzhen Jinghuada Logistics Co..


AFLLOG_FTP
AFL LOGISTICS.


SKYNET_WORLDWIDE
SkyNet Worldwide Express.


NOVA_POSHTA
Nova Poshta (novaposhta.ua).


SEINO
Seino.


SZENDEX
SZENDEX.


BPOST_INT
Bpost international.


DBSCHENKER_SV
DB Schenker Sweden.


AO_DEUTSCHLAND
AO Deutschland.


EU_FLEET_SOLUTIONS
EU Fleet Solutions.


PCFCORP
PCF Final Mile.


LINKBRIDGE
Link Bridge(BeiJing)international logistics co..


PRIMAMULTICIPTA
PT Prima Multi Cipta.


COUREX
Urbanfox.


ZAJIL_EXPRESS
Zajil Express Company.


COLLECTCO
CollectCo.


JTEXPRESS
J&T EXPRESS MALAYSIA.


FEDEX_UK
FedEx® UK.


USHIP
uShip courier.


PIXSELL
PIXSELL LOGISTICS.


SHIPTOR
Shiptor.


CDEK
CDEK courier.


VNM_VIETTELPOST
ViettelPost.


CJ_CENTURY
CJ Century.


GSO
GSO(GLS-USA).


VIWO
VIWO IoT.


SKYBOX
SKYBOX.


KERRYTJ
Kerry TJ Logistics.


NTLOGISTICS_VN
Nhat Tin Logistics.


SDH_SCM
lightning monkey.


ZINC
Zinc courier.


DPE_SOUTH_AFRC
DPE South Africa.


CESKA_CZ
Czech Post.


ACS_GR
ACS Courier.


DEALERSEND
DealerSend.


JOCOM
Jocom.


CSE
CSE courier.


TFORCE_FINALMILE
TForce Final Mile.


SHIP_GATE
ShipGate.


SHIPTER
SHIPTER.


NATIONAL_SAMEDAY
National Sameday.


YUNEXPRESS
YunExpress.


CAINIAO
AliExpress Standard Shipping.


DMS_MATRIX
DMSMatrix.


DIRECTLOG
Directlog (www.directlog.com.br).


ASENDIA_US
Asendia USA.


_3JMSLOGISTICS
3JMS Logistics.


LICCARDI_EXPRESS
LICCARDI EXPRESS COURIER.


SKY_POSTAL
SkyPostal.


CNWANGTONG
cnwangtong.


POSTNORD_LOGISTICS_DK
ostnord denmark.


LOGISTIKA
Logistika.


CELERITAS
Celeritas Transporte.


PRESSIODE
Pressio.


SHREE_MARUTI
Shree Maruti Courier Services Pvt Ltd.


LOGISTICSWORLDWIDE_HK
Logistic Worldwide Express (LWE Honkong).


EFEX
eFEx (E-Commerce Fulfillment & Express).


LOTTE
Lotte Global Logistics.


LONESTAR
Lone Star Overnight.


APRISAEXPRESS
Aprisa Express.


BEL_RS
BEL North Russia.


OSM_WORLDWIDE
OSM Worldwide.


WESTGATE_GL
Westgate Global.


FASTRACK
Fasttrack.


DTD_EXPR
DTD Express.


ALFATREX
AlfaTrex.


PROMEDDELIVERY
ProMed Delivery.


THABIT_LOGISTICS
Thabit Logistics.


HCT_LOGISTICS
HCT LOGISTICS CO.LTD..


CARRY_FLAP
Carry-Flap Co..


US_OLD_DOMINION
Old Dominion Freight Line.


ANICAM_BOX
ANICAM BOX EXPRESS.


WANBEXPRESS
WanbExpress.


AN_POST
An Post.


DPD_LOCAL
DPD Local.


STALLIONEXPRESS
Stallion Express.


RAIDEREX
RaidereX.


SHOPFANS
ShopfansRU LLC.


KYUNGDONG_PARCEL
Kyungdong Parcel.


CHAMPION_LOGISTICS
Champion Logistics.


PICKUPP_SGP
PICK UPP (Singapore).


MORNING_EXPRESS
Morning Express.


NACEX
NACEX.


THENILE_WEBHOOK
SortHub courier.


HOLISOL
Holisol.


LBCEXPRESS_FTP
LBC EXPRESS INC..


KURASI
KURASI.


USF_REDDAWAY
USF Reddaway.


APG
APG eCommerce Solutions.


CN_BOXC
BoxC courier.


ECOSCOOTING
ECOSCOOTING.


MAINWAY
Mainway.


PAPERFLY
Paperfly Private Limited.


HOUNDEXPRESS
Hound Express.


BOX_BERRY
Boxberry courier.


EP_BOX
EP-Box courier.


PLUS_LOG_UK
Plus UK Logistics.


FULFILLA
Fulfilla.


ASE
ASE KARGO.


MAIL_PLUS
MailPlus.


XPO_LOGISTICS
XPO logistics.


WNDIRECT
wnDirect.


CLOUDWISH_ASIA
Cloudwish Asia.


ZELERIS
Zeleris.


GIO_EXPRESS
Gio Express.


OCS_WORLDWIDE
OCS WORLDWIDE.


ARK_LOGISTICS
ARK Logistics.


AQUILINE
Aquiline.


PILOT_FREIGHT
Pilot Freight Services.


QWINTRY
Qwintry Logistics.


DANSKE_FRAGT
Danske Fragtaend.


CARRIERS
Carriers courier.


AIR_CANADA_GLOBAL
Rivo (Air canada).


PRESIDENT_TRANS
PRESIDENT TRANSNET CORP.


STEPFORWARDFS
STEP FORWARD FREIGHT SERVICE CO LTD.


SKYNET_UK
Skynet UK.


PITTOHIO
PITT OHIO.


CORREOS_EXPRESS
Correos Express.


RL_US
RL Carriers.


DESTINY
Destiny Transportation.


UK_YODEL
Yodel (www.yodel.co.uk).


COMET_TECH
CometTech.


DHL_PARCEL_RU
DHL Parcel Russia.


TNT_REFR
TNT Reference.


SHREE_ANJANI_COURIER
Shree Anjani Courier.


MIKROPAKKET_BE
Mikropakket Belgium.


ETS_EXPRESS
RETS express.


COLIS_PRIVE
Colis Privé.


CN_YUNDA
Yunda Express.


AAA_COOPER
AAA Cooper.


ROCKET_PARCEL
Rocket Parcel International.


_360LION
360 Lion Express.


PANDU
PANDU.


PROFESSIONAL_COURIERS
PROFESSIONAL COURIERS.


FLYTEXPRESS
FLYTEXPRESS.


LOGISTICSWORLDWIDE_MY
LOGISTICSWORLDWIDE MY.


CORREOS_DE_ESPANA
CORREOS DE ESPANA.


IMX
IMX.


FOUR_PX_EXPRESS
FOUR PX EXPRESS.


XPRESSBEES
XPRESSBEES.


PICKUPP_VNM
pickupp_vnm.


STARTRACK_EXPRESS
startrack_express.


FR_COLISSIMO
fr_colissimo.


NACEX_SPAIN_REFERENCE
nacex_spain_reference.


DHL_SUPPLY_CHAIN_AU
dhl_supply_chain_au.


ESHIPPING
Eshipping.


SHREETIRUPATI
SHREE TIRUPATI COURIER SERVICES PVT. LTD..


HX_EXPRESS
HX Express.


INDOPAKET
INDOPAKET.


CN_17POST
17 Post Service.


K1_EXPRESS
K1 Express.


CJ_GLS
CJ GLS.


MYS_GDEX
GDEX courier.


NATIONEX
Nationex courier.


ANJUN
Anjun couriers.


FARGOOD
FarGood.


SMG_EXPRESS
SMG Direct.


RZYEXPRESS
RZY Express.


SEFL
Southeastern Freight Lines.


TNT_CLICK_IT
TNT-Click Italy.


HDB
Haidaibao.


HIPSHIPPER
Hipshipper.


RPXLOGISTICS
RPX Logistics.


KUEHNE
Kuehne + Nagel.


IT_NEXIVE
Nexive (TNT Post Italy).


PTS
PTS courier.


SWISS_POST_FTP
Swiss Post FTP.


FASTRK_SERV
Fastrak Services.


_4_72
4-72 Entregando.


US_YRC
YRC courier.


POSTNL_INTL_3S
PostNL International 3S.


ELIAN_POST
Yilian (Elian) Supply Chain.


CUBYN
Cubyn.


SAU_SAUDI_POST
Saudi Post.


ABXEXPRESS_MY
ABX Express.


HUAHAN_EXPRESS
HUAHANG EXPRESS.


ZES_EXPRESS
Eshun international Logistic.


ZEPTO_EXPRESS
ZeptoExpress.


SKYNET_ZA
Skynet World Wide Express South Africa.


ZEEK_2_DOOR
Zeek2Door.


BLINKLASTMILE
Blink.


POSTA_UKR
UkrPoshta.


CHROBINSON
C.H. Robinson Worldwide.


CN_POST56
Post56.


COURANT_PLUS
Courant Plus.


SCUDEX_EXPRESS
Scudex Express.


SHIPENTEGRA
ShipEntegra.


B_TWO_C_EUROPE
B2C courier Europe.


COPE
Cope Sensitive Freight.


IND_GATI
Gati-KWE.


CN_WISHPOST
WishPost.


NACEX_ES
NACEX Spain.


TAQBIN_HK
TAQBIN Hong Kong.


GLOBALTRANZ
GlobalTranz.


HKD
Qingdao HKD International Logistics.


BJSHOMEDELIVERY
BJS Distribution courier.


OMNIVA
Omniva.


SUTTON
Sutton Transport.


PANTHER_REFERENCE
Panther Reference.


SFCSERVICE
SFC Service.


LTL
LTL COURIER.


PARKNPARCEL
Park N Parcel.


SPRING_GDS
Spring GDS.


ECEXPRESS
ECexpress.


INTERPARCEL_AU
Interparcel Australia.


AGILITY
Agility.


XL_EXPRESS
XL Express.


ADERONLINE
Ader couriers.


DIRECTCOURIERS
Direct Couriers.


PLANZER
Planzer Group.


SENDING
Sending Transporte Urgente y Comunicacion.


NINJAVAN_WB
Ninjavan Webhook.


NATIONWIDE_MY
Nationwide Express Courier Services Bhd (www.nationwide.com.my).


SENDIT
Sendit.


GB_ARROW
Arrow XL.


IND_GOJAVAS
GoJavas.


KPOST
Korea Post.


DHL_FREIGHT
DHL Freight.


BLUECARE
Bluecare Express Ltd.


JINDOUYUN
jindouyun courier.


TRACKON
Trackon Couriers Pvt. Ltd.


GB_TUFFNELLS
Tuffnells Parcels Express.


TRUMPCARD
TRUMPCARD LLC.


ETOTAL
eTotal Solution Limited.


SFPLUS_WEBHOOK
Zeek courier.


SEKOLOGISTICS
SEKO Logistics.


HERMES_2MANN_HANDLING
Hermes Einrichtungs Service GmbH & Co. KG.


DPD_LOCAL_REF
DPD Local reference.


UDS
United Delivery Service.


ZA_SPECIALISED_FREIGHT
Specialised Freight.


THA_KERRY
Kerry Express Thailand.


PRT_INT_SEUR
SEUR International.


BRA_CORREIOS
Correios Brazil.


NZ_NZ_POST
New Zealand Post.


CN_EQUICK
Equick China.


MYS_EMS
Malaysia Post EMS / Pos Laju.


GB_NORSK
Norsk Global.


ESP_MRW
MRW spain.


ESP_PACKLINK
Packlink.


KANGAROO_MY
Kangaroo Worldwide Express.


RPX
RPX Online.


XDP_UK_REFERENCE
XDP Express Reference.


NINJAVAN_MY
ninja van (www.ninjavan.co).


ADICIONAL
Adicional Logistics.


ROADBULL
Red Carpet Logistics.


YAKIT
Yakit courier.


MAILAMERICAS
MailAmericas.


MIKROPAKKET
Mikropakket.


DYNALOGIC
Dynamic Logistics.


DHL_ES
DHL Spain(www.dhl.com).


DHL_PARCEL_NL
DHL Parcel NL.


DHL_GLOBAL_MAIL_ASIA
DHL Global Mail Asia (www.dhl.com).


DAWN_WING
Dawn Wing.


GENIKI_GR
Geniki Taxydromiki.


HERMESWORLD_UK
hermesworld_uk.


ALPHAFAST
Alphafast (www.alphafast.com).


BUYLOGIC
buylogic.


EKART
Ekart logistics (ekartlogistics.com).


MEX_SENDA
mexico senda express.


SFC_LOGISTICS
SFC.


POST_SERBIA
Posta Serbia.


IND_DELHIVERY
Delhivery India.


DE_DPD_DELISTRACK
DPD Germany.


RPD2MAN
RPD2man Deliveries.


CN_SF_EXPRESS
SF Express (www.sf-express.com).


YANWEN
Yanwen Logistics.


MYS_SKYNET
Skynet Malaysia.


CORREOS_DE_MEXICO
correos mexico.


CBL_LOGISTICA
CBL Logistica.


MEX_ESTAFETA
Estafeta (www.estafeta.com).


AU_AUSTRIAN_POST
Austrian Post (Registered).


RINCOS
Rincos.


NLD_DHL
DHL Netherland.


RUSSIAN_POST
Russian post.


COURIERS_PLEASE
CouriersPlease (couriersplease.com.au).


POSTNORD_LOGISTICS
PostNord Logistics.


FEDEX
Fedex.


DPE_EXPRESS
DPE Express.


DPD
DPD.


ADSONE
ADSone.


IDN_JNE
JNE Express (Jalur Nugraha Ekakurir).


THECOURIERGUY
The Courier Guy.


CNEXPS
CNE Express.


PRT_CHRONOPOST
Chronopost Portugal.


LANDMARK_GLOBAL
Landmark Global.


IT_DHL_ECOMMERCE
DHL International.


ESP_NACEX
NACEX Spain.


PRT_CTT
CTT Portugal.


BE_KIALA
Kiala.


ASENDIA_UK
Asendia UK.


GLOBAL_TNT
TNT global.


POSTUR_IS
Iceland Post.


EPARCEL_KR
eParcel Korea.


INPOST_PACZKOMATY
InPost Paczkomaty.


IT_POSTE_ITALIA
Poste italiane (www.poste.it).


BE_BPOST
Bpost (www.bpost.be).


PL_POCZTA_POLSKA
Poczta Polska (www.poczta-polska.pl).


MYS_MYS_POST
Malaysia Post.


SG_SG_POST
Singapore Post.


THA_THAILAND_POST
Thailand Post (www.thailandpost.co.th).


LEXSHIP
LexShip.


FASTWAY_NZ
Fastway New Zealand.


DHL_AU
DHL Supply Chain Australia.


COSTMETICSNOW
Cosmetics Now.


PFLOGISTICS
PFL.


LOOMIS_EXPRESS
Loomis Express.


GLS_ITALY
GLS Italy.


LINE
Line Clear Express & Logistics Sdn Bhd.


GEL_EXPRESS
Gel Express Logistik.


HUODULL
Huodull.


NINJAVAN_SG
Ninja van Singapore.


JANIO
Janio Asia.


AO_COURIER
AO Logistics.


BRT_IT_SENDER_REF
BRT Bartolini(Sender Reference).


SAILPOST
SAILPOST.


LALAMOVE
Lalamove.


NEWZEALAND_COURIERS
NEW ZEALAND COURIERS.


ETOMARS
Etomars.


VIRTRANSPORT
VIR Transport.


WIZMO
Wizmo.


PALLETWAYS
Palletways.


I_DIKA
i-dika.


CFL_LOGISTICS
CFL Logistics.


GEMWORLDWIDE
GEM Worldwide.


GLOBAL_EXPRESS
Tai Wan Global Business.


LOGISTYX_TRANSGROUP
Transgroup courier.


WESTBANK_COURIER
West Bank Courier.


ARCO_SPEDIZIONI
Arco Spedizioni SP.


YDH_EXPRESS
YDH express.


PARCELINKLOGISTICS
Parcelink Logistics.


CNDEXPRESS
CND Express.


NOX_NIGHT_TIME_EXPRESS
NOX NightTimeExpress.


AERONET
Aeronet couriers.


LTIANEXP
LTIAN EXP.


INTEGRA2_FTP
Integra2.


PARCELONE
PARCEL ONE.


NOX_NACHTEXPRESS
Innight Express Germany GmbH (nox NachtExpress).


CN_CHINA_POST_EMS
China Post.


CHUKOU1
Chukou1.


GLS_SLOV
GLS General Logistics Systems Slovakia s.r.o..


ORANGE_DS
OrangeDS (Orange Distribution Solutions Inc).


JOOM_LOGIS
Joom Logistics.


AUS_STARTRACK
StarTrack (startrack.com.au).


DHL
dhl Global.


GB_APC
APC postal logistics germany.


BONDSCOURIERS
Bonds Courier Service (bondscouriers.com.au).


JPN_JAPAN_POST
Japan Post.


USPS
United States Postal Service.


WINIT
WinIt.


ARG_OCA
OCA Argentina.


TW_TAIWAN_POST
Taiwan Post.


DMM_NETWORK
DMM Network.


TNT
TNT Express.


BH_POSTA
BH Posta (www.posta.ba).


SWE_POSTNORD
Postnord sweden.


CA_CANADA_POST
Canada Post.


WISELOADS
Wiseloads.


ASENDIA_HK
Asendia HonKong.


NLD_GLS
GLS Netherland.


MEX_REDPACK
Redpack.


JET_SHIP
Jet-Ship Worldwide.


DE_DHL_EXPRESS
DHL Express.


NINJAVAN_THAI
Ninja van Thai.


RABEN_GROUP
Raben Group.


ESP_ASM
ASM(GLS Spain).


HRV_HRVATSKA
Hrvatska posta.


GLOBAL_ESTES
Estes Express Lines.


LTU_LIETUVOS
Lietuvos pastas.


BEL_DHL
DHL Benelux.


AU_AU_POST
Australia Post.


SPEEDEXCOURIER
SPEEDEX couriers.


FR_COLIS
Colissimo.


ARAMEX
Aramex.


DPEX
DPEX (www.dpex.com).


MYS_AIRPAK
Airpak Express.


CUCKOOEXPRESS
Cuckoo Express.


DPD_POLAND
DPD Poland.


NLD_POSTNL
PostNL International.


NIM_EXPRESS
Nim Express.


QUANTIUM
Quantium.


SENDLE
Sendle.


ESP_REDUR
Redur Spain.


MATKAHUOLTO
Matkahuolto.


CPACKET
Cpacket couriers.


POSTI
Posti courier.


HUNTER_EXPRESS
Hunter Express.


CHOIR_EXP
Choir Express Indonesia.


LEGION_EXPRESS
Legion Express.


AUSTRIAN_POST_EXPRESS
austrian post.


GRUPO
Grupo ampm.


POSTA_RO
Post Roman (www.posta-romana.ro).


INTERPARCEL_UK
Interparcel UK.


GLOBAL_ABF
ABF Freight.


POSTEN_NORGE
Posten Norge (www.posten.no).


XPERT_DELIVERY
Xpert Delivery.


DHL_REFR
DHl (Reference number).


DHL_HK
DHL HonKong.


SKYNET_UAE
SKYNET UAE.


GOJEK
Gojek.


YODEL_INTNL
Yodel International.


JANCO
Janco Ecommerce.


YTO
YTO Express.


WISE_EXPRESS
Wise Express.


JTEXPRESS_VN
J&T Express Vietnam.


FEDEX_INTL_MLSERV
FedEx International MailService.


VAMOX
VAMOX.


AMS_GRP
AMS Group.


DHL_JP
DHL Japan.


HRPARCEL
HR Parcel.


GESWL
GESWL Express.


BLUESTAR
Blue Star.


CDEK_TR
CDEK TR.


DESCARTES
Innovel courier.


DELTEC_UK
Deltec Courier.


DTDC_EXPRESS
DTDC express.


TOURLINE
tourline.


BH_WORLDWIDE
B&H Worldwide.


OCS
OCS ANA Group.


YINGNUO_LOGISTICS
yingnuo logistics.


UPS
United Parcel Service.


TOLL
Toll IPEC.


PRT_SEUR
SEUR portugal.


DTDC_AU
DTDC Australia.


THA_DYNAMIC_LOGISTICS
Dynamic Logistics.


UBI_LOGISTICS
UBI Smart Parcel.


FEDEX_CROSSBORDER
FedEx Cross Border.


A1POST
A1Post.


TAZMANIAN_FREIGHT
Tazmanian Freight Systems.


CJ_INT_MY
CJ International malaysia.


SAIA_FREIGHT
Saia LTL Freight.


SG_QXPRESS
Qxpress.


NHANS_SOLUTIONS
Nhans Solutions.


DPD_FR
DPD France.


COORDINADORA
Coordinadora.


ANDREANI
Grupo logistico Andreani.


DOORA
Doora Logistics.


INTERPARCEL_NZ
Interparcel New Zealand.


PHL_JAMEXPRESS
Jam Express Philippines.


BEL_BELGIUM_POST
bel_belgium_post.


US_APC
us_apc.


IDN_POS
idn_pos.


FR_MONDIAL
fr_mondial.


DE_DHL
DE DHL.


HK_RPX
hk_rpx.


DHL_PIECEID
dhl_pieceid.


VNPOST_EMS
vnpost_ems.


RRDONNELLEY
rrdonnelley.


DPD_DE
dpd_de.


DELCART_IN
delcart_in.


IMEXGLOBALSOLUTIONS
imexglobalsolutions.


ACOMMERCE
ACOMMERCE.


EURODIS
eurodis.


CANPAR
CANPAR.


GLS
GLS.


IND_ECOM
Ecom Express.


ESP_ENVIALIA
Envialia.


DHL_UK
dhl UK.


SMSA_EXPRESS
SMSA Express.


TNT_FR
TNT France.


DEX_I
DEX-I courier.


BUDBEE_WEBHOOK
Budbee courier.


COPA_COURIER
Copa Airlines Courier.


VNM_VIETNAM_POST
Vietnam Post.


DPD_HK
DPD HongKong.


TOLL_NZ
Toll New Zealand.


ECHO
Echo courier.


FEDEX_FR
FedEx® Freight.


BORDEREXPRESS
Border Express.


MAILPLUS_JPN
MailPlus (Japan).


TNT_UK_REFR
TNT UK Reference.


KEC
KEC courier.


DPD_RO
DPD Romania.


TNT_JP
TNT_JP.


TH_CJ
TH_CJ.


EC_CN
EC_CN.


FASTWAY_UK
FASTWAY_UK.


FASTWAY_US
FASTWAY_US.


GLS_DE
GLS_DE.


GLS_ES
GLS_ES.


GLS_FR
GLS_FR.


MONDIAL_BE
MONDIAL_BE.


SGT_IT
SGT_IT.


TNT_CN
TNT_CN.


TNT_DE
TNT_DE.


TNT_ES
TNT_ES.


TNT_PL
TNT_PL.


PARCELFORCE
PARCELFORCE.


SWISS_POST
SWISS POST.


TOLL_IPEC
TOLL IPEC.


AIR_21
AIR 21.


AIRSPEED
AIRSPEED.


BERT
BERT.


BLUEDART
BLUEDART.


COLLECTPLUS
COLLECTPLUS.


COURIERPLUS
COURIERPLUS.


COURIER_POST
COURIER POST.


DHL_GLOBAL_MAIL
dhl_global_mail.


DPD_UK
dpd_uk.


DELTEC_DE
DELTEC DE.


DEUTSCHE_DE
deutsche_de.


DOTZOT
DOTZOT.


ELTA_GR
elta_gr.


EMS_CN
ems_cn.


ECARGO
ECARGO.


ENSENDA
ENSENDA.


FERCAM_IT
fercam_it.


FASTWAY_ZA
fastway_za.


FASTWAY_AU
fastway_au.


FIRST_LOGISITCS
first_logisitcs.


GEODIS
GEODIS.


GLOBEGISTICS
GLOBEGISTICS.


GREYHOUND
GREYHOUND.


JETSHIP_MY
jetship_my.


LION_PARCEL
LION PARCEL.


AEROFLASH
AEROFLASH.


ONTRAC
ONTRAC.


SAGAWA
SAGAWA.


SIODEMKA
SIODEMKA.


STARTRACK
startrack.


TNT_AU
tnt_au.


TNT_IT
tnt_it.


TRANSMISSION
TRANSMISSION.


YAMATO
YAMATO.


DHL_IT
dhl_it.


DHL_AT
dhl_at.


LOGISTICSWORLDWIDE_KR
LOGISTICSWORLDWIDE KR.


GLS_SPAIN
gls_spain.


AMAZON_UK_API
amazon_uk_api.


DPD_FR_REFERENCE
dpd_fr_reference.


DHLPARCEL_UK
dhlparcel_uk.


MEGASAVE
megasave.


QUALITYPOST
qualitypost.


IDS_LOGISTICS
ids_logistics.


JOYINGBOX
joyingbox.


PANTHER_ORDER_NUMBER
panther_order_number.


WATKINS_SHEPARD
watkins_shepard.


FASTTRACK
fasttrack.


UP_EXPRESS
up_express.


ELOGISTICA
elogistica.


ECOURIER
ecourier.


CJ_PHILIPPINES
cj_philippines.


SPEEDEX
speedex.


ORANGECONNEX
orangeconnex.


TECOR
tecor.


SAEE
saee.


GLS_ITALY_FTP
gls_italy_ftp.


DELIVERE
delivere.


YYCOM
yycom.


ADICIONAL_PT
Adicional Logistics.


DKSH
DKSH.


NIPPON_EXPRESS_FTP
Nippon Express.


GOLS
GO Logistics & Storage.


FUJEXP
FUJIE EXPRESS.


QTRACK
QTrack.


OMLOGISTICS_API
OM LOGISTICS LTD.


GDPHARM
GDPharm Logistics.


MISUMI_CN
MISUMI Group Inc..


AIR_CANADA
Rivo.


CITY56_WEBHOOK
City Express.


SAGAWA_API
Sagawa.


KEDAEX
KedaEX.


PGEON_API
Pgeon.


WEWORLDEXPRESS
We World Express.


JT_LOGISTICS
J&T International logistics.


TRUSK
Trusk France.


VIAXPRESS
ViaXpress.


DHL_SUPPLYCHAIN_ID
DHL Supply Chain Indonesia.


ZUELLIGPHARMA_SFTP
Zuellig Pharma Korea.


MEEST
Meest.


TOLL_PRIORITY
Toll Priority.


MOTHERSHIP_API
Mothership.


CAPITAL
Capital Transport.


EUROPAKET_API
Europacket+.


HFD
HFD.


TOURLINE_REFERENCE
Tourline Express.


GIO_ECOURIER
GIO Express Inc.


CN_LOGISTICS
CN Logistics.


PANDION
Pandion.


BPOST_API
Bpost API.


PASSPORTSHIPPING
Passport Shipping.


PAKAJO
Pakajo World.


DACHSER
DACHSER.


YUSEN_SFTP
Yusen Logistics.


SHYPLITE
Shypmax.


XYY
Xingyunyi Logistics.


MWD
Metropolitan Warehouse & Delivery.


FAXECARGO
Faxe Cargo.


MAZET
Groupe Mazet.


FIRST_LOGISTICS_API
First Logistics.


SPRINT_PACK
SPRINT PACK.


HERMES_DE_FTP
Hermes Germany.


CONCISE
Concise.


KERRY_EXPRESS_TW_API
Kerry Express TaiWan.


EWE
EWE Global Express.


FASTDESPATCH
Fast Despatch Logistics Limited.


ABCUSTOM_SFTP
AB Custom Group.


CHAZKI
Chazki.


SHIPPIE
Shippie.


GEODIS_API
GEODIS - Distribution & Express.


NAQEL_EXPRESS
Naqel Express.


PAPA_WEBHOOK
Papa.


FORWARDAIR
Forward Air.


DIALOGO_LOGISTICA_API
Dialogo Logistica.


LALAMOVE_API
Lalamove.


TOMYDOOR
Tomydoor.


KRONOS_WEBHOOK
Kronos Express.


JTCARGO
J&T CARGO.


T_CAT
T-cat.


CONCISE_WEBHOOK
Concise.


TELEPORT_WEBHOOK
Teleport.


CUSTOMCO_API
The Custom Companies.


SPX_TH
Shopee Xpress.


BOLLORE_LOGISTICS
Bollore Logistics.


CLICKLINK_SFTP
ClickLink.


M3LOGISTICS
M3 Logistics.


VNPOST_API
Vietnam Post.


AXLEHIRE_FTP
Axlehire.


SHADOWFAX
Shadowfax.


MYHERMES_UK_API
EVRi.


DAIICHI
Daiichi Freight System Inc.


MENSAJEROSURBANOS_API
Mensajeros Urbanos.


POLARSPEED
PolarSpeed Inc.


IDEXPRESS_ID
iDexpress Indonesia.


PAYO
Payo.


WHISTL_SFTP
Whistl.


INTEX_DE
INTEX Paketdienst GmbH.


TRANS2U
Trans2u.


PRODUCTCAREGROUP_SFTP
Product Care Services Limited.


BIGSMART
Big Smart.


EXPEDITORS_API_REF
Expeditors API Reference.


AITWORLDWIDE_API
AIT.


WORLDCOURIER
World Courier.


QUIQUP
Quiqup.


AGEDISS_SFTP
Agediss.


ANDREANI_API
Andreani.


CRLEXPRESS
CRL Express.


SMARTCAT
SMARTCAT.


CROSSFLIGHT
Crossflight Limited.


PROCARRIER
Pro Carrier.


DHL_REFERENCE_API
DHL (Reference number).


SEINO_API
Seino.


WSPEXPRESS
WSP Express.


KRONOS
Kronos Express.


TOTAL_EXPRESS_API
Total Express.


PARCLL
PARCLL.


XPEDIGO
Xpedigo.


STAR_TRACK_WEBHOOK
StarTrack.


GPOST
Georgian Post.


UCS
UCS.


DMFGROUP
DMF.


COORDINADORA_API
Coordinadora.


MARKEN
Marken.


NTL
NTL logistics.


REDJEPAKKETJE
Red je Pakketje.


ALLIED_EXPRESS_FTP
Allied Express (FTP).


MONDIALRELAY_ES
Mondial Relay Spain(Punto Pack).


NAEKO_FTP
Naeko Logistics.


MHI
Mhi.


SHIPPIFY
Shippify, Inc.


MALCA_AMIT_API
Malca Amit.


JTEXPRESS_SG_API
J&T Express Singapore.


DACHSER_WEB
DACHSER.


FLIGHTLG
Flight Logistics Group.


CAGO
Cago.


COM1EXPRESS
ComOne Express.


TONAMI_FTP
Tonami.


PACKFLEET
PACKFLEET.


PUROLATOR_INTERNATIONAL
Purolator International.


WINESHIPPING_WEBHOOK
Wineshipping.


DHL_ES_SFTP
DHL Spain Domestic.


PCHOME_API
網家速配股份有限公司.


CESKAPOSTA_API
Czech Post.


GORUSH
Go Rush.


HOMERUNNER
HomeRunner.


AMAZON_ORDER
Amazon order.


EFWNOW_API
Estes Forwarding Worldwide.


CBL_LOGISTICA_API
CBL Logistica (API).


NIMBUSPOST
NimbusPost.


LOGWIN_LOGISTICS
Logwin Logistics.


NOWLOG_API
Sequoialog.


DPD_NL
DPD Netherlands.


GODEPENDABLE
Dependable Supply Chain Services.


ESDEX
Top Ideal Express.


LOGISYSTEMS_SFTP
Kiitäjät.


EXPEDITORS
Expeditors.


SNTGLOBAL_API
Snt Global Etrax.


SHIPX
ShipX.


QINTL_API
Quickstat Courier LLC.


PACKS
Packs.


POSTNL_INTERNATIONAL
PostNL International.


AMAZON_EMAIL_PUSH
Amazon.


DHL_API
DHL.


SPX
Shopee Express.


AXLEHIRE
AxleHire.


ICSCOURIER
ICS COURIER.


DIALOGO_LOGISTICA
Dialogo Logistica.


SHUNBANG_EXPRESS
ShunBang Express.


TCS_API
TCS.


SF_EXPRESS_CN
SF Express China.


PACKETA
Packeta.


SIC_TELIWAY
Teliway SIC Express.


MONDIALRELAY_FR
Mondial Relay France.


INTIME_FTP
InTime.


JD_EXPRESS
京东物流.


FASTBOX
Fastbox.


PATHEON
Patheon Logistics.


INDIA_POST
India Post Domestic.


TIPSA_REF
Tipsa Reference.


ECOFREIGHT
Eco Freight.


VOX
VOX SOLUCION EMPRESARIAL SRL.


DIRECTFREIGHT_AU_REF
Direct Freight Express.


BESTTRANSPORT_SFTP
Best Transport.


AUSTRALIA_POST_API
Australia Post.


FRAGILEPAK_SFTP
FragilePAK.


FLIPXP
FlipXpress.


VALUE_WEBHOOK
Value Logistics.


DAESHIN
Daeshin.


SHERPA
Sherpa.


MWD_API
Metropolitan Warehouse & Delivery.


SMARTKARGO
SmartKargo.


DNJ_EXPRESS
DNJ Express.


GOPEOPLE
Go People.


MYSENDLE_API
mySendle.


ARAMEX_API
Aramex.


PIDGE
Pidge.


THAIPARCELS
TP Logistic.


PANTHER_REFERENCE_API
Panther Reference.


POSTAPLUS
Posta Plus.


BUFFALO
BUFFALO.


U_ENVIOS
U-ENVIOS.


ELITE_CO
Elite Express.


ROCHE_INTERNAL_SFTP
Roche Internal Courier.


DBSCHENKER_ICELAND
DB Schenker Iceland.


TNT_FR_REFERENCE
TNT France Reference.


NEWGISTICSAPI
Newgistics API.


GLOVO
Glovo.


GWLOGIS_API
G.I.G.


SPREETAIL_API
Spreetail.


MOOVA
Moova.


PLYCONGROUP
Plycon Transportation Group.


USPS_WEBHOOK
USPS Informed Visibility - Webhook.


REIMAGINEDELIVERY
maergo.


EDF_FTP
Eurodifarm.


DAO365
DAO365.


BIOCAIR_FTP
BioCair.


RANSA_WEBHOOK
Ransa.


SHIPXPRES
SHIPXPRESS.


COURANT_PLUS_API
Courant Plus.


SHIPA
SHIPA.


HOMELOGISTICS
Home Logistics.


DX
DX.


POSTE_ITALIANE_PACCOCELERE
Poste Italiane Paccocelere.


TOLL_WEBHOOK
Toll Group.


LCTBR_API
LCT do Brasil.


DX_FREIGHT
DX Freight.


DHL_SFTP
DHL Express.


SHIPROCKET
Shiprocket X.


UBER_WEBHOOK
Uber.


STATOVERNIGHT
Stat Overnight.


BURD
Burd Delivery.


FASTSHIP
Fastship Express.


IBVENTURE_WEBHOOK
IB Venture.


GATI_KWE_API
Gati-KWE.


CRYOPDP_FTP
CryoPDP.


HUBBED
HUBBED.


TIPSA_API
Tipsa API.


ARASKARGO
Aras Cargo.


THIJS_NL
Thijs Logistiek.


ATSHEALTHCARE_REFERENCE
ATS Healthcare.


99MINUTOS
99minutos.


HELLENIC_POST
Hellenic (Greece) Post.


HSM_GLOBAL
HSM Global.


MNX
MNX.


NMTRANSFER
N&M Transfer Co., Inc..


LOGYSTO
Logysto.


INDIA_POST_INT
India Post International.


AMAZON_FBA_SWISHIP_IN
Swiship IN.


SRT_TRANSPORT
SRT Transport.


BOMI
Bomi Group.


DELIVERR_SFTP
Deliverr.


HSDEXPRESS
HSDEXPRESS.


SIMPLETIRE_WEBHOOK
SimpleTire.


HUNTER_EXPRESS_SFTP
Hunter Express.


UPS_API
UPS.


WOOYOUNG_LOGISTICS_SFTP
WOO YOUNG LOGISTICS CO.,LTD..


PHSE_API
PHSE.


WISH_EMAIL_PUSH
Wish.


NORTHLINE
Northline.


MEDAFRICA
Med Africa Logistics.


DPD_AT_SFTP
DPD Austria.


ANTERAJA
Anteraja.


DHL_GLOBAL_FORWARDING_API
DHL Global Forwarding API.


LBCEXPRESS_API
LBC EXPRESS INC..


SIMSGLOBAL
Sims Global.


CDLDELIVERS
CDL Last Mile.


TYP
TYP.


TESTING_COURIER_WEBHOOK
Testing Courier.


PANDAGO_API
Pandago.


ROYAL_MAIL_FTP
Royal Mail.


THUNDEREXPRESS
Thunder Express Australia.


SECRETLAB_WEBHOOK
Secretlab.


SETEL
Setel Express.


JD_WORLDWIDE
JD Worldwide.


DPD_RU_API
DPD Russia.


ARGENTS_WEBHOOK
Argents Express Group.


POSTONE
Post ONE.


TUSKLOGISTICS
Tusk Logistics.


RHENUS_UK_API
Rhenus Logistics UK.


TAQBIN_SG_API
Yamato Singapore.


INNTRALOG_SFTP
Inntralog GmbH.


DAYROSS
Day & Ross.


CORREOSEXPRESS_API
Correos Express (API).


INTERNATIONAL_SEUR_API
International Seur API.


YODEL_API
Yodel API.


HEROEXPRESS
Hero Express.


DHL_SUPPLYCHAIN_IN
DHL supply chain India.


URGENT_CARGUS
Urgent Cargus.


FRONTDOORCORP
FRONTdoor Collective.


JTEXPRESS_PH
J&T Express Philippines.


PARCELSTARS_WEBHOOK
Parcelstars.


DPD_SK_SFTP
DPD Slovakia.


MOVIANTO
Movianto.


OZEPARTS_SHIPPING
Ozeparts Shipping.


KARGOMKOLAY
KargomKolay (CargoMini).


TRUNKRS
Trunkrs.


OMNIRPS_WEBHOOK
Omni Returns.


CHILEXPRESS
Chile Express.


TESTING_COURIER
Testing Courier.


JNE_API
JNE (API).


BJSHOMEDELIVERY_FTP
BJS Distribution, Storage & Couriers - FTP.


DEXPRESS_WEBHOOK
D Express.


USPS_API
USPS API.


TRANSVIRTUAL
TransVirtual.


SOLISTICA_API
solistica.


CHIENVENTURE_WEBHOOK
Chienventure.


DPD_UK_SFTP
DPD UK.


INPOST_UK
InPost.


JAVIT
Javit.


ZTO_DOMESTIC
ZTO Express China.


DHL_GT_API
DHL Global Forwarding Guatemala.


CEVA_TRACKING
CEVA Package.


KOMON_EXPRESS
Komon Express.


EASTWESTCOURIER_FTP
East West Courier Pte Ltd.


DANNIAO
Danniao.


SPECTRAN
Spectran.


DELIVER_IT
Deliver-iT.


RELAISCOLIS
Relais Colis.


GLS_SPAIN_API
GLS Spain.


POSTPLUS
PostPlus.


AIRTERRA
Airterra.


GIO_ECOURIER_API
GIO Express Ecourier.


DPD_CH_SFTP
DPD Switzerland.


FEDEX_API
FedEx®.


INTERSMARTTRANS
INTERSMARTTRANS & SOLUTIONS SL.


HERMES_UK_SFTP
Hermes UK.


EXELOT_FTP
Exelot Ltd..


DHL_PA_API
DHL GLOBAL FORWARDING PANAMÁ.


VIRTRANSPORT_SFTP
Vir Transport.


WORLDNET
Worldnet Logistics.


INSTABOX_WEBHOOK
Instabox.


KNG
Keuhne + Nagel Global.


FLASHEXPRESS_WEBHOOK
Flash Express.


MAGYAR_POSTA_API
Magyar Posta.


WESHIP_API
WeShip.


OHI_WEBHOOK
Ohi.


MUDITA
MUDITA.


BLUEDART_API
Bluedart.


T_CAT_API
T-cat.


ADS
ADS Express.


HERMES_IT
HR Parcel.


FITZMARK_API
FitzMark.


POSTI_API
Posti API.


SMSA_EXPRESS_WEBHOOK
SMSA Express.


TAMERGROUP_WEBHOOK
Tamer Logistics.


LIVRAPIDE
Livrapide.


NIPPON_EXPRESS
Nippon Express.


BETTERTRUCKS
Better Trucks.


FAN
FAN COURIER EXPRESS.


PB_USPSFLATS_FTP
USPS Flats (Pitney Bowes).


PARCELRIGHT
Parcel Right.


ITHINKLOGISTICS
iThink Logistics.


KERRY_EXPRESS_TH_WEBHOOK
Kerry Logistics.


ECOUTIER
eCoutier.


SHOWL
SENHONG INTERNATIONAL LOGISTICS.


BRT_IT_API
BRT Bartolini API.


RIXONHK_API
Rixon Logistics.


DBSCHENKER_API
DB Schenker.


ILYANGLOGIS
Ilyang logistics.


MAIL_BOX_ETC
Mail Boxes Etc..


WESHIP
WeShip.


DHL_GLOBAL_MAIL_API
DHL eCommerce Solutions.


ACTIVOS24_API
Activos24.


ATSHEALTHCARE
ATS Healthcare.


LUWJISTIK
Luwjistik.


GW_WORLD
Gebrüder Weiss.


FAIRSENDEN_API
fairsenden.


SERVIP_WEBHOOK
SerVIP.


SWISHIP
Swiship.


TANET
Transport Ambientales.


HOTSIN_CARGO
SHENZHEN HOTSIN CARGO INT'L FORWARDING CO.,LTD.


DIREX
Direx.


HUANTONG
HuanTong.


IMILE_API
iMile.


AUEXPRESS
Au Express.


NYTLOGISTICS
NYT SUPPLY CHAIN LOGISTICS Co.,LTD.


DSV_REFERENCE
DSV Futurewave.


NOVOFARMA_WEBHOOK
Novofarma.


AITWORLDWIDE_SFTP
AIT.


SHOPOLIVE
Olive.


FNF_ZA
Fast & Furious.


DHL_ECOMMERCE_GC
DHL eCommerce Greater China.


FETCHR
Fetchr.


STARLINKS_API
Starlinks Global.


YYEXPRESS
YYEXPRESS.


SERVIENTREGA
Servientrega.


HANJIN
HanJin.


SPANISH_SEUR_FTP
Spanish Seur.


DX_B2B_CONNUM
DX (B2B).


HELTHJEM_API
Helthjem.


INEXPOST
Inexpost.


A2B_BA
A2B Express Logistics.


RHENUS_GROUP
Rhenus Logistics.


SBERLOGISTICS_RU
Sber Logistics.


MALCA_AMIT
Malca-Amit.


PPL
Professional Parcel Logistics.


OSM_WORLDWIDE_SFTP
OSM Worldwide.


ACILOGISTIX
ACI Logistix.


OPTIMACOURIER
Optima Courier.


NOVA_POSHTA_API
Nova Poshta API.


LOGGI
Loggi.


YIFAN
YiFan Express.


MYDYNALOGIC
My DynaLogic.


MORNINGLOBAL
Morning Global.


CONCISE_API
Concise.


FXTRAN
Falcon Express.


DELIVERYOURPARCEL_ZA
Deliver Your Parcel.


UPARCEL
uParcel.


MOBI_BR
Mobi Logistica.


LOGINEXT_WEBHOOK
T&W Delivery.


EMS
EMS.


SPEEDY
Speedy.


ZOOM_RED
Zoom.


NAVLUNGO
Navlungo.


CASTLEPARCELS
Castle Parcels.


WEEE
Weee.


PACKALY
Packaly.


YUNHUIPOST
Yunhuipost.


YOUPARCEL
YouParcel.


LEMAN
Leman.


MOOVIN
Moovin.


URB_IT
Urb-it.


MULTIENTREGAPANAMA
Multientrega.


JUSDASR
Jusdasr.


DISCOUNTPOST
Discount Post.


RHENUS_UK
Rhenus Logistics UK.


SWISHIP_JP
Swiship JP.


GLS_US
GLS USA.


SMTL
Southwestern Motor Transport. Inc.


EMEGA
Discount Post Emega.


EXPRESSONE_SV
EXPRESSONE Slovenia.


HEPSIJET
hepsiJET.


WELIVERY
Welivery.


BRINGER
Bringer Parcel Services.


EASYROUTES
EasyRoutes.


MRW
MRW.


RPM
RPM.


DPD_PRT
DPD Portugal.


GLS_ROMANIA
GLS Romania.


LMPARCEL
LM Parcel.


GTAGSM
GTA GSM.


DOMINO
DOMINO.


ESHIPPER
eShipper.


TRANSPAK
Transpak Inc..


XINDUS
Xindus.


AOYUE
Aoyue.


EASYPARCEL
Easyparcel.


EXPRESSONE
EXPRESSONE.


SENDEO_KARGO
Sendeo Kargo.


SPEEDAF
Speedaf Express.


ETOWER
eTower.


GCX
GC Express.


NINJAVAN_VN
Ninjavan Vietnam.


ALLEGRO
Allegro.


JUMPPOINT
Jumppoint.


SHIPGLOBAL_US
ShipGlobal.


KINISI
Kinisi Transport Pty Ltd.


OAKH
Oakh Harbour Freight Lines.


AWEST
American West.


BARSAN
Barsan Global Lojistik.


ENERGOLOGISTIC
Energo Logistic.


MADROOEX
Madrooex.


GOBOLT
GoBolt.


SWISS_UNIVERSAL_EXPRESS
Swiss Universal Express.


IORDIRECT
IOR Direct Solutions.


XMSZM
xmszm.


GLS_HUN
GLS Hungary.


SENDY
Sendy Express.


BRAUNSEXPRESS
Brauns Express.


GRANDSLAMEXPRESS
Grand Slam Express.


XGS
XGS.


OTSCHILE
OTS.


PACK_UP
Pack-Up.


PARCELSTARS
Parcelstars.


TEAMEXPRESSLLC
Team Express Service LLC.


ASYADEXPRESS
Asyad Express.


TDN
TDN.


EARLYBIRD
Early Bird.


CACESA
Cacesa.


PARCELJET
Parceljet.


MNG_KARGO
MNG Kargo.


SUPERPACKLINE
Super Pac Line.


SPEEDX
SpeedX.


VESYL
Vesyl.


SKYKING
Sky King.


DIRMENSAJERIA
DIR.


NETLOGIXGROUP
Netlogix.


ZYOU
ZYEX.


JAWAR
Jawar.


AGSYSTEMS
Associate Global Systems.


GPS
GPS.


PTT_KARGO
PTT Kargo.


MAERGO
Maergo.


ARIHANTCOURIER
AICS.


VTFE
VicTas Freight Express.


YUNANT
Yunant.


URBIFY
Urbify.


PACK_MAN
pack-man.


LIEFERGRUN
LIEFERGRUN.


OBIBOX
Obibox.


PAIKEDA
Paikeda.


SCOTTY
Scotty.


INTELCOM_CA
Intelcom.


SWE
swe.


ASENDIA
Asendia Global.


DPD_AT
DPD Austria.


RELAY
Relay.


ATA
ATA.


SKYEXPRESS_INTERNATIONAL
SkyExpress Internationals.


SURAT_KARGO
Surat Kargo.


SGLINK
SG LINK.


FLEETOPTICSINC
FleetOptics.


SHOPLINE
shopline.


PIGGYSHIP
PIGGYSHIP.


LOGOIX
LogoiX.


KOLAY_GELSIN
Kolay Gelsin.


ASSOCIATED_COURIERS
Associated Couriers.


UPS_CHECKER
ups-checker.


WINESHIPPING
Wineshipping.


SPEDISCI
Spedisci online.


 
{
  • "tracking_number": "string",
  • "carrier_name_other": "string",
  • "carrier": "DPD_RU"
}
Tracker Status
The status of the item shipment.


string (Tracker Status)   [ 1 .. 64 ] characters ^[0-9A-Z_]+$
The status of the item shipment.


 Enum Value Description
CANCELLED
The shipment was cancelled and the tracking number no longer applies.


SHIPPED
The merchant has assigned a tracking number to the items being shipped from the Order. This does not correspond to the carrier's actual status for the shipment. The latest status of the parcel must be retrieved from the carrier.


 
"CANCELLED"
tracker_item
The details of the items in the shipment.


name
string  [ 1 .. 127 ] characters 
The item name or title.


 
quantity
string  [ 1 .. 10 ] characters ^[1-9][0-9]{0,9}$
The item quantity. Must be a whole number.


 
sku
string  [ 1 .. 127 ] characters 
The stock keeping unit (SKU) for the item. This can contain unicode characters.


 
url
string <uri>   [ 1 .. 2048 ] characters 
The URL to the item being purchased. Visible to buyer and used in buyer experiences.


 
image_url
string <uri>   [ 1 .. 2048 ] characters ^(https:)([/|.|\w|\s|-])*\.(?:jpg|gif|png|jpe...
The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.


 
object (universal_product_code) 
The Universal Product Code of the item.


 
{}
tracker_request
The tracking details of an order.


tracking_number
required
string  [ 1 .. 64 ] characters 
The tracking number for the shipment. This property supports Unicode.


 
carrier_name_other
string  [ 1 .. 64 ] characters 
The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.


 
carrier
required
string (carrier)   [ 1 .. 64 ] characters ^[0-9A-Z_]+$
The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier to OTHER and set carrier name in carrier_name_other. For allowed values, see Carriers.


 Enum Value Description
DPD_RU
DPD Russia.


BG_BULGARIAN_POST
Bulgarian Posts.


KR_KOREA_POST
Koreapost (www.koreapost.go.kr).


ZA_COURIERIT
Courier IT.


FR_EXAPAQ
DPD France (formerly exapaq).


ARE_EMIRATES_POST
Emirates Post.


GAC
GAC.


GEIS
Geis CZ.


SF_EX
SF Express.


PAGO
Pago Logistics.


MYHERMES
MyHermes UK.


DIAMOND_EUROGISTICS
Diamond Eurogistics Limited.


CORPORATECOURIERS_WEBHOOK
Corporate Couriers.


BOND
Bond courier.


OMNIPARCEL
Omni Parcel.


SK_POSTA
Slovenska pošta.


PUROLATOR
purolator.


FETCHR_WEBHOOK
Mena 360 (Fetchr).


THEDELIVERYGROUP
TDG – The Delivery Group.


CELLO_SQUARE
Cello Square.


TARRIVE
TONDA GLOBAL.


COLLIVERY
MDS Collivery Pty (Ltd).


MAINFREIGHT
Mainfreight.


IND_FIRSTFLIGHT
First Flight Couriers.


ACSWORLDWIDE
ACS Worldwide Express.


AMSTAN
Amstan Logistics.


OKAYPARCEL
OkayParcel.


ENVIALIA_REFERENCE
Envialia Reference.


SEUR_ES
Seur Spain.


CONTINENTAL
Continental.


FDSEXPRESS
FDSEXPRESS.


AMAZON_FBA_SWISHIP
Swiship UK.


WYNGS
Wyngs.


DHL_ACTIVE_TRACING
DHL Active Tracing.


ZYLLEM
Zyllem.


RUSTON
Ruston.


XPOST
Xpost.ph.


CORREOS_ES
correos Express (www.correos.es).


DHL_FR
DHL France (www.dhl.com).


PAN_ASIA
Pan-Asia International.


BRT_IT
BRT couriers Italy (www.brt.it).


SRE_KOREA
SRE Korea (www.srekorea.co.kr).


SPEEDEE
Spee-Dee Delivery.


TNT_UK
TNT UK Limited (www.tnt.com).


VENIPAK
Venipak.


SHREENANDANCOURIER
SHREE NANDAN COURIER.


CROSHOT
Croshot.


NIPOST_NG
NIpost (www.nipost.gov.ng).


EPST_GLBL
ePost Global.


NEWGISTICS
Newgistics.


POST_SLOVENIA
Post of Slovenia.


JERSEY_POST
Jersey Post.


BOMBINOEXP
Bombino Express Pvt.


WMG
WMG Delivery.


XQ_EXPRESS
XQ Express.


FURDECO
Furdeco.


LHT_EXPRESS
LHT Express.


SOUTH_AFRICAN_POST_OFFICE
South African Post Office.


SPOTON
SPOTON Logistics Pvt Ltd.


DIMERCO
Dimerco Express Group.


CYPRUS_POST_CYP
cyprus post.


ABCUSTOM
AB Custom Group.


IND_DELIVREE
deliverE.


CN_BESTEXPRESS
Best Express.


DX_SFTP
DX (SFTP).


PICKUPP_MYS
PICK UPP.


FMX
FMX.


HELLMANN
Hellmann Worldwide Logistics.


SHIP_IT_ASIA
Ship It Asia.


KERRY_ECOMMERCE
Kerry eCommerce.


FRETERAPIDO
Frete Rapido.


PITNEY_BOWES
Pitney Bowes.


XPRESSEN_DK
Xpressen courier.


SEUR_SP_API
Spanish Seur API.


DELIVERYONTIME
DELIVERYONTIME LOGISTICS PVT LTD.


JINSUNG
JINSUNG TRADING.


TRANS_KARGO
Trans Kargo Internasional.


SWISHIP_DE
Swiship DE.


IVOY_WEBHOOK
Ivoy courier.


AIRMEE_WEBHOOK
Airmee couriers.


DHL_BENELUX
dhl benelux.


FIRSTMILE
FirstMile.


FASTWAY_IR
Fastway Ireland.


HH_EXP
Hua Han Logistics.


MYS_MYPOST_ONLINE
Mypostonline.


TNT_NL
THT Netherland.


TIPSA
TIPSA courier.


TAQBIN_MY
TAQBIN Malaysia.


KGMHUB
KGM Hub.


INTEXPRESS
Internet Express.


OVERSE_EXP
Overseas Express.


ONECLICK
One click delivery services.


ROADRUNNER_FREIGHT
Roadbull Logistics.


GLS_CROTIA
GLS Croatia.


MRW_FTP
MRW courier.


BLUEX
Blue Express.


DYLT
Daylight Transport.


DPD_IR
DPD Ireland.


SIN_GLBL
Sin Global Express.


TUFFNELLS_REFERENCE
Tuffnells Parcels Express- Reference.


CJPACKET
CJ Packet.


MILKMAN
Milkman courier.


ASIGNA
ASIGNA courier.


ONEWORLDEXPRESS
One World Express.


ROYAL_MAIL
RoyalShipments.


VIA_EXPRESS
Viaxpress.


TIGFREIGHT
TIG Freight.


ZTO_EXPRESS
ZTO Express.


TWO_GO
2GO Courier.


IML
IML courier.


INTEL_VALLEY
Intel-Valley Supply chain (ShenZhen) Co. Ltd.


EFS
EFS (E-commerce Fulfillment Service).


UK_UK_MAIL
UK mail (ukmail.com).


RAM
RAM courier.


ALLIEDEXPRESS
Allied Express.


APC_OVERNIGHT
APC overnight (apc-overnight.com).


SHIPPIT
Shippit.


TFM
TFM Xpress.


M_XPRESS
M Xpress Sdn Bhd.


HDB_BOX
Haidaibao (BOX).


CLEVY_LINKS
Clevy Links.


IBEONE
Beone Logistics.


FIEGE_NL
Fiege Netherlands.


KWE_GLOBAL
KWE Global.


CTC_EXPRESS
CTC Express.


AMAZON
Amazon Shipping.


MORE_LINK
Morelink.


JX
JX courier.


EASY_MAIL
Easy Mail.


ADUIEPYLE
A Duie Pyle.


GB_PANTHER
Panther.


EXPRESSSALE
Expresssale.


SG_DETRACK
Detrack.


TRUNKRS_WEBHOOK
Trunkrs courier.


MATDESPATCH
Matdespatch.


DICOM
GLS Logistic Systems Canada Ltd./Dicom.


MBW
MBW Courier Inc..


KHM_CAMBODIA_POST
Cambodia Post.


SINOTRANS
Sinotrans.


BRT_IT_PARCELID
BRT Bartolini(Parcel ID).


DHL_SUPPLY_CHAIN
DHL Supply Chain APAC.


DHL_PL
DHL Poland.


TOPYOU
TopYou.


PALEXPRESS
PAL Express Limited.


DHL_SG
dhl Singapore.


CN_WEDO
WeDo Logistics.


FULFILLME
Fulfillme.


DPD_DELISTRACK
DPD delistrack.


UPS_REFERENCE
UPS Reference.


CARIBOU
Caribou.


LOCUS_WEBHOOK
Locus courier.


DSV
DSV courier.


P2P_TRC
P2P TrakPak.


DIRECTPARCELS
Direct Parcels.


NOVA_POSHTA_INT
Nova Poshta (International).


FEDEX_POLAND
FedEx® Poland Domestic.


CN_JCEX
JCEX courier.


FAR_INTERNATIONAL
FAR international.


IDEXPRESS
IDEX courier.


GANGBAO
GANGBAO Supplychain.


NEWAY
Neway Transport.


POSTNL_INT_3_S
PostNL International.


RPX_ID
RPX Indonesia.


DESIGNERTRANSPORT_WEBHOOK
Designer Transport.


GLS_SLOVEN
GLS Slovenia.


PARCELLED_IN
Parcelled.in.


GSI_EXPRESS
GSI EXPRESS.


CON_WAY
Con-way Freight.


BROUWER_TRANSPORT
Brouwer Transport en Logistiek.


CPEX
Captain Express International.


ISRAEL_POST
Israel Post.


DTDC_IN
DTDC India.


PTT_POST
PTT Post.


XDE_WEBHOOK
Ximex Delivery Express.


TOLOS
Tolos courier.


GIAO_HANG
Giao hàng nhanh.


GEODIS_ESPACE
Geodis E-space.


MAGYAR_HU
Magyar Post.


DOORDASH_WEBHOOK
DoorDash.


TIKI_ID
Tiki shipment.


CJ_HK_INTERNATIONAL
CJ Logistics International(Hong Kong).


STAR_TRACK_EXPRESS
Star Track Express.


HELTHJEM
Helthjem.


SFB2C
SF International.


FREIGHTQUOTE
Freightquote by C.H. Robinson.


LANDMARK_GLOBAL_REFERENCE
Landmark Global Reference.


PARCEL2GO
Parcel2Go.


DELNEXT
Delnext.


RCL
Red Carpet Logistics.


CGS_EXPRESS
CGS Express.


HK_POST
Hongkong Post (www.hongkongpost.hk).


SAP_EXPRESS
SAP EXPRESS.


PARCELPOST_SG
Parcel Post Singapore.


HERMES
HermesWorld UK.


IND_SAFEEXPRESS
Safexpress.


TOPHATTEREXPRESS
Tophatter Express.


MGLOBAL
PT MGLOBAL LOGISTICS INDONESIA.


AVERITT
Averitt Express.


LEADER
leader.


_2EBOX
2ebox courier.


SG_SPEEDPOST
Singapore Speedpost.


DBSCHENKER_SE
DB Schenker (www.dbschenker.com).


ISR_POST_DOMESTIC
Israel Post Domestic.


BESTWAYPARCEL
Best Way Parcel.


ASENDIA_DE
asendia_de.


NIGHTLINE_UK
nightline_uk.


TAQBIN_SG
taqbin_sg.


TCK_EXPRESS
TCK Express.


ENDEAVOUR_DELIVERY
Endeavour Delivery.


NANJINGWOYUAN
Nanjing Woyuan.


HEPPNER_FR
Heppner France.


EMPS_CN
EMPS Express.


FONSEN
Fonsen Logistics.


PICKRR
Pickrr.


APC_OVERNIGHT_CONNUM
APC Overnight Consignment.


STAR_TRACK_NEXT_FLIGHT
Star Track Next Flight.


DAJIN
Shanghai Aqrum Chemical Logistics Co.Ltd.


UPS_FREIGHT
UPS Freight.


POSTA_PLUS
Posta Plus.


CEVA
CEVA LOGISTICS.


ANSERX
ANSERX courier.


JS_EXPRESS
JS EXPRESS.


PADTF
padtf.com.


UPS_MAIL_INNOVATIONS
UPS Mail Innovations.


SYPOST
Sunyou Post.


AMAZON_SHIP_MCF
Amazon Shipping + Amazon MCF.


YUSEN
Yusen Logistics.


BRING
Bring.


SDA_IT
SDA Italy.


GBA
GBA Services Ltd.


NEWEGGEXPRESS
Newegg Express.


SPEEDCOURIERS_GR
Speed Couriers.


FORRUN
forrun Pvt Ltd (Arpatech Venture).


PICKUP
Pickupp.


ECMS
ECMS International Logistics Co..


INTELIPOST
Intelipost (TMS for LATAM).


FLASHEXPRESS
Flash Express.


CN_STO
STO Express.


SEKO_SFTP
SEKO Worldwide.


HOME_DELIVERY_SOLUTIONS
Home Delivery Solutions Ltd.


DPD_HGRY
DPD Hungary.


KERRYTTC_VN
Kerry Express (Vietnam) Co Ltd.


JOYING_BOX
Joying Box.


TOTAL_EXPRESS
Total Express.


ZJS_EXPRESS
ZJS International.


STARKEN
STARKEN couriers.


DEMANDSHIP
DemandShip.


CN_DPEX
DPEX.


AUPOST_CN
AuPost China.


LOGISTERS
Logisters.


GOGLOBALPOST
Global Post.


GLS_CZ
GLS Czech Republic.


PAACK_WEBHOOK
Paack courier.


GRAB_WEBHOOK
Grab courier.


PARCELPOINT
Parcelpoint.


ICUMULUS
iCumulus.


DAIGLOBALTRACK
DAI Post.


GLOBAL_IPARCEL
i-parcel.


YURTICI_KARGO
Yurtici Kargo.


CN_PAYPAL_PACKAGE
PayPal Package.


PARCEL_2_POST
Parcel To Post.


GLS_IT
GLS Italy.


PIL_LOGISTICS
PIL Logistics (China) Co..


HEPPNER
Heppner Internationale Spedition GmbH & Co..


GENERAL_OVERNIGHT
Go!Express and logistics.


HAPPY2POINT
Happy 2ThePoint.


CHITCHATS
Chit Chats.


SMOOTH
Smooth Couriers.


CLE_LOGISTICS
CL E-Logistics Solutions Limited.


FIEGE
Fiege Logistics.


MX_CARGO
M&X cargo.


ZIINGFINALMILE
Ziing Final Mile Inc.


DAYTON_FREIGHT
Dayton Freight.


TCS
TCS courier.


AEX
AEX Group.


HERMES_DE
Hermes Germany.


ROUTIFIC_WEBHOOK
Routific.


GLOBAVEND
Globavend.


CJ_LOGISTICS
CJ Logistics International.


PALLET_NETWORK
The Pallet Network.


RAF_PH
RAF Philippines.


UK_XDP
XDP Express.


PAPER_EXPRESS
Paper Express.


LA_POSTE_SUIVI
La Poste.


PAQUETEXPRESS
Paquetexpress.


LIEFERY
liefery.


STRECK_TRANSPORT
Streck Transport.


PONY_EXPRESS
Pony express.


ALWAYS_EXPRESS
Always Express.


GBS_BROKER
GBS-Broker.


CITYLINK_MY
City-Link Express.


ALLJOY
ALLJOY SUPPLY CHAIN.


YODEL
yodel.


YODEL_DIR
Yodel Direct.


STONE3PL
STONE3PL.


PARCELPAL_WEBHOOK
ParcelPal.


DHL_ECOMERCE_ASA
DHL eCommerce Asia (API).


SIMPLYPOST
J&T Express Singapore.


KY_EXPRESS
Kua Yue Express.


SHENZHEN
shenzhen 1st International Logistics(Group)Co.


US_LASERSHIP
LaserShip.


UC_EXPRE
ucexpress.


DIDADI
DIDADI Logistics tech.


CJ_KR
CJ Korea Express.


DBSCHENKER_B2B
DB Schenker B2B.


MXE
MXE Express.


CAE_DELIVERS
CAE Delivers.


PFCEXPRESS
PFC Express.


WHISTL
Whistl.


WEPOST
WePost Sdn Bhd.


DHL_PARCEL_ES
DHL parcel Spain(www.dhl.com).


DDEXPRESS
DD Express Courier.


ARAMEX_AU
Aramex Australia (formerly Fastway AU).


BNEED
Bneed courier.


HK_TGX
Kerry Express Hong Kong.


LATVIJAS_PASTS
Latvijas Pasts.


VIAEUROPE
ViaEurope.


CORREO_UY
Correo Uruguayo.


CHRONOPOST_FR
Chronopost france (www.chronopost.fr).


J_NET
J-Net.


_6LS
6ls.com.


BLR_BELPOST
Belpost.


BIRDSYSTEM
BirdSystem.


DOBROPOST
DobroPost.


WAHANA_ID
Wahana express (www.wahana.com).


WEASHIP
Weaship.


SONICTL
Sonic Transportation & Logistics.


KWT
Shenzhen Jinghuada Logistics Co..


AFLLOG_FTP
AFL LOGISTICS.


SKYNET_WORLDWIDE
SkyNet Worldwide Express.


NOVA_POSHTA
Nova Poshta (novaposhta.ua).


SEINO
Seino.


SZENDEX
SZENDEX.


BPOST_INT
Bpost international.


DBSCHENKER_SV
DB Schenker Sweden.


AO_DEUTSCHLAND
AO Deutschland.


EU_FLEET_SOLUTIONS
EU Fleet Solutions.


PCFCORP
PCF Final Mile.


LINKBRIDGE
Link Bridge(BeiJing)international logistics co..


PRIMAMULTICIPTA
PT Prima Multi Cipta.


COUREX
Urbanfox.


ZAJIL_EXPRESS
Zajil Express Company.


COLLECTCO
CollectCo.


JTEXPRESS
J&T EXPRESS MALAYSIA.


FEDEX_UK
FedEx® UK.


USHIP
uShip courier.


PIXSELL
PIXSELL LOGISTICS.


SHIPTOR
Shiptor.


CDEK
CDEK courier.


VNM_VIETTELPOST
ViettelPost.


CJ_CENTURY
CJ Century.


GSO
GSO(GLS-USA).


VIWO
VIWO IoT.


SKYBOX
SKYBOX.


KERRYTJ
Kerry TJ Logistics.


NTLOGISTICS_VN
Nhat Tin Logistics.


SDH_SCM
lightning monkey.


ZINC
Zinc courier.


DPE_SOUTH_AFRC
DPE South Africa.


CESKA_CZ
Czech Post.


ACS_GR
ACS Courier.


DEALERSEND
DealerSend.


JOCOM
Jocom.


CSE
CSE courier.


TFORCE_FINALMILE
TForce Final Mile.


SHIP_GATE
ShipGate.


SHIPTER
SHIPTER.


NATIONAL_SAMEDAY
National Sameday.


YUNEXPRESS
YunExpress.


CAINIAO
AliExpress Standard Shipping.


DMS_MATRIX
DMSMatrix.


DIRECTLOG
Directlog (www.directlog.com.br).


ASENDIA_US
Asendia USA.


_3JMSLOGISTICS
3JMS Logistics.


LICCARDI_EXPRESS
LICCARDI EXPRESS COURIER.


SKY_POSTAL
SkyPostal.


CNWANGTONG
cnwangtong.


POSTNORD_LOGISTICS_DK
ostnord denmark.


LOGISTIKA
Logistika.


CELERITAS
Celeritas Transporte.


PRESSIODE
Pressio.


SHREE_MARUTI
Shree Maruti Courier Services Pvt Ltd.


LOGISTICSWORLDWIDE_HK
Logistic Worldwide Express (LWE Honkong).


EFEX
eFEx (E-Commerce Fulfillment & Express).


LOTTE
Lotte Global Logistics.


LONESTAR
Lone Star Overnight.


APRISAEXPRESS
Aprisa Express.


BEL_RS
BEL North Russia.


OSM_WORLDWIDE
OSM Worldwide.


WESTGATE_GL
Westgate Global.


FASTRACK
Fasttrack.


DTD_EXPR
DTD Express.


ALFATREX
AlfaTrex.


PROMEDDELIVERY
ProMed Delivery.


THABIT_LOGISTICS
Thabit Logistics.


HCT_LOGISTICS
HCT LOGISTICS CO.LTD..


CARRY_FLAP
Carry-Flap Co..


US_OLD_DOMINION
Old Dominion Freight Line.


ANICAM_BOX
ANICAM BOX EXPRESS.


WANBEXPRESS
WanbExpress.


AN_POST
An Post.


DPD_LOCAL
DPD Local.


STALLIONEXPRESS
Stallion Express.


RAIDEREX
RaidereX.


SHOPFANS
ShopfansRU LLC.


KYUNGDONG_PARCEL
Kyungdong Parcel.


CHAMPION_LOGISTICS
Champion Logistics.


PICKUPP_SGP
PICK UPP (Singapore).


MORNING_EXPRESS
Morning Express.


NACEX
NACEX.


THENILE_WEBHOOK
SortHub courier.


HOLISOL
Holisol.


LBCEXPRESS_FTP
LBC EXPRESS INC..


KURASI
KURASI.


USF_REDDAWAY
USF Reddaway.


APG
APG eCommerce Solutions.


CN_BOXC
BoxC courier.


ECOSCOOTING
ECOSCOOTING.


MAINWAY
Mainway.


PAPERFLY
Paperfly Private Limited.


HOUNDEXPRESS
Hound Express.


BOX_BERRY
Boxberry courier.


EP_BOX
EP-Box courier.


PLUS_LOG_UK
Plus UK Logistics.


FULFILLA
Fulfilla.


ASE
ASE KARGO.


MAIL_PLUS
MailPlus.


XPO_LOGISTICS
XPO logistics.


WNDIRECT
wnDirect.


CLOUDWISH_ASIA
Cloudwish Asia.


ZELERIS
Zeleris.


GIO_EXPRESS
Gio Express.


OCS_WORLDWIDE
OCS WORLDWIDE.


ARK_LOGISTICS
ARK Logistics.


AQUILINE
Aquiline.


PILOT_FREIGHT
Pilot Freight Services.


QWINTRY
Qwintry Logistics.


DANSKE_FRAGT
Danske Fragtaend.


CARRIERS
Carriers courier.


AIR_CANADA_GLOBAL
Rivo (Air canada).


PRESIDENT_TRANS
PRESIDENT TRANSNET CORP.


STEPFORWARDFS
STEP FORWARD FREIGHT SERVICE CO LTD.


SKYNET_UK
Skynet UK.


PITTOHIO
PITT OHIO.


CORREOS_EXPRESS
Correos Express.


RL_US
RL Carriers.


DESTINY
Destiny Transportation.


UK_YODEL
Yodel (www.yodel.co.uk).


COMET_TECH
CometTech.


DHL_PARCEL_RU
DHL Parcel Russia.


TNT_REFR
TNT Reference.


SHREE_ANJANI_COURIER
Shree Anjani Courier.


MIKROPAKKET_BE
Mikropakket Belgium.


ETS_EXPRESS
RETS express.


COLIS_PRIVE
Colis Privé.


CN_YUNDA
Yunda Express.


AAA_COOPER
AAA Cooper.


ROCKET_PARCEL
Rocket Parcel International.


_360LION
360 Lion Express.


PANDU
PANDU.


PROFESSIONAL_COURIERS
PROFESSIONAL COURIERS.


FLYTEXPRESS
FLYTEXPRESS.


LOGISTICSWORLDWIDE_MY
LOGISTICSWORLDWIDE MY.


CORREOS_DE_ESPANA
CORREOS DE ESPANA.


IMX
IMX.


FOUR_PX_EXPRESS
FOUR PX EXPRESS.


XPRESSBEES
XPRESSBEES.


PICKUPP_VNM
pickupp_vnm.


STARTRACK_EXPRESS
startrack_express.


FR_COLISSIMO
fr_colissimo.


NACEX_SPAIN_REFERENCE
nacex_spain_reference.


DHL_SUPPLY_CHAIN_AU
dhl_supply_chain_au.


ESHIPPING
Eshipping.


SHREETIRUPATI
SHREE TIRUPATI COURIER SERVICES PVT. LTD..


HX_EXPRESS
HX Express.


INDOPAKET
INDOPAKET.


CN_17POST
17 Post Service.


K1_EXPRESS
K1 Express.


CJ_GLS
CJ GLS.


MYS_GDEX
GDEX courier.


NATIONEX
Nationex courier.


ANJUN
Anjun couriers.


FARGOOD
FarGood.


SMG_EXPRESS
SMG Direct.


RZYEXPRESS
RZY Express.


SEFL
Southeastern Freight Lines.


TNT_CLICK_IT
TNT-Click Italy.


HDB
Haidaibao.


HIPSHIPPER
Hipshipper.


RPXLOGISTICS
RPX Logistics.


KUEHNE
Kuehne + Nagel.


IT_NEXIVE
Nexive (TNT Post Italy).


PTS
PTS courier.


SWISS_POST_FTP
Swiss Post FTP.


FASTRK_SERV
Fastrak Services.


_4_72
4-72 Entregando.


US_YRC
YRC courier.


POSTNL_INTL_3S
PostNL International 3S.


ELIAN_POST
Yilian (Elian) Supply Chain.


CUBYN
Cubyn.


SAU_SAUDI_POST
Saudi Post.


ABXEXPRESS_MY
ABX Express.


HUAHAN_EXPRESS
HUAHANG EXPRESS.


ZES_EXPRESS
Eshun international Logistic.


ZEPTO_EXPRESS
ZeptoExpress.


SKYNET_ZA
Skynet World Wide Express South Africa.


ZEEK_2_DOOR
Zeek2Door.


BLINKLASTMILE
Blink.


POSTA_UKR
UkrPoshta.


CHROBINSON
C.H. Robinson Worldwide.


CN_POST56
Post56.


COURANT_PLUS
Courant Plus.


SCUDEX_EXPRESS
Scudex Express.


SHIPENTEGRA
ShipEntegra.


B_TWO_C_EUROPE
B2C courier Europe.


COPE
Cope Sensitive Freight.


IND_GATI
Gati-KWE.


CN_WISHPOST
WishPost.


NACEX_ES
NACEX Spain.


TAQBIN_HK
TAQBIN Hong Kong.


GLOBALTRANZ
GlobalTranz.


HKD
Qingdao HKD International Logistics.


BJSHOMEDELIVERY
BJS Distribution courier.


OMNIVA
Omniva.


SUTTON
Sutton Transport.


PANTHER_REFERENCE
Panther Reference.


SFCSERVICE
SFC Service.


LTL
LTL COURIER.


PARKNPARCEL
Park N Parcel.


SPRING_GDS
Spring GDS.


ECEXPRESS
ECexpress.


INTERPARCEL_AU
Interparcel Australia.


AGILITY
Agility.


XL_EXPRESS
XL Express.


ADERONLINE
Ader couriers.


DIRECTCOURIERS
Direct Couriers.


PLANZER
Planzer Group.


SENDING
Sending Transporte Urgente y Comunicacion.


NINJAVAN_WB
Ninjavan Webhook.


NATIONWIDE_MY
Nationwide Express Courier Services Bhd (www.nationwide.com.my).


SENDIT
Sendit.


GB_ARROW
Arrow XL.


IND_GOJAVAS
GoJavas.


KPOST
Korea Post.


DHL_FREIGHT
DHL Freight.


BLUECARE
Bluecare Express Ltd.


JINDOUYUN
jindouyun courier.


TRACKON
Trackon Couriers Pvt. Ltd.


GB_TUFFNELLS
Tuffnells Parcels Express.


TRUMPCARD
TRUMPCARD LLC.


ETOTAL
eTotal Solution Limited.


SFPLUS_WEBHOOK
Zeek courier.


SEKOLOGISTICS
SEKO Logistics.


HERMES_2MANN_HANDLING
Hermes Einrichtungs Service GmbH & Co. KG.


DPD_LOCAL_REF
DPD Local reference.


UDS
United Delivery Service.


ZA_SPECIALISED_FREIGHT
Specialised Freight.


THA_KERRY
Kerry Express Thailand.


PRT_INT_SEUR
SEUR International.


BRA_CORREIOS
Correios Brazil.


NZ_NZ_POST
New Zealand Post.


CN_EQUICK
Equick China.


MYS_EMS
Malaysia Post EMS / Pos Laju.


GB_NORSK
Norsk Global.


ESP_MRW
MRW spain.


ESP_PACKLINK
Packlink.


KANGAROO_MY
Kangaroo Worldwide Express.


RPX
RPX Online.


XDP_UK_REFERENCE
XDP Express Reference.


NINJAVAN_MY
ninja van (www.ninjavan.co).


ADICIONAL
Adicional Logistics.


ROADBULL
Red Carpet Logistics.


YAKIT
Yakit courier.


MAILAMERICAS
MailAmericas.


MIKROPAKKET
Mikropakket.


DYNALOGIC
Dynamic Logistics.


DHL_ES
DHL Spain(www.dhl.com).


DHL_PARCEL_NL
DHL Parcel NL.


DHL_GLOBAL_MAIL_ASIA
DHL Global Mail Asia (www.dhl.com).


DAWN_WING
Dawn Wing.


GENIKI_GR
Geniki Taxydromiki.


HERMESWORLD_UK
hermesworld_uk.


ALPHAFAST
Alphafast (www.alphafast.com).


BUYLOGIC
buylogic.


EKART
Ekart logistics (ekartlogistics.com).


MEX_SENDA
mexico senda express.


SFC_LOGISTICS
SFC.


POST_SERBIA
Posta Serbia.


IND_DELHIVERY
Delhivery India.


DE_DPD_DELISTRACK
DPD Germany.


RPD2MAN
RPD2man Deliveries.


CN_SF_EXPRESS
SF Express (www.sf-express.com).


YANWEN
Yanwen Logistics.


MYS_SKYNET
Skynet Malaysia.


CORREOS_DE_MEXICO
correos mexico.


CBL_LOGISTICA
CBL Logistica.


MEX_ESTAFETA
Estafeta (www.estafeta.com).


AU_AUSTRIAN_POST
Austrian Post (Registered).


RINCOS
Rincos.


NLD_DHL
DHL Netherland.


RUSSIAN_POST
Russian post.


COURIERS_PLEASE
CouriersPlease (couriersplease.com.au).


POSTNORD_LOGISTICS
PostNord Logistics.


FEDEX
Fedex.


DPE_EXPRESS
DPE Express.


DPD
DPD.


ADSONE
ADSone.


IDN_JNE
JNE Express (Jalur Nugraha Ekakurir).


THECOURIERGUY
The Courier Guy.


CNEXPS
CNE Express.


PRT_CHRONOPOST
Chronopost Portugal.


LANDMARK_GLOBAL
Landmark Global.


IT_DHL_ECOMMERCE
DHL International.


ESP_NACEX
NACEX Spain.


PRT_CTT
CTT Portugal.


BE_KIALA
Kiala.


ASENDIA_UK
Asendia UK.


GLOBAL_TNT
TNT global.


POSTUR_IS
Iceland Post.


EPARCEL_KR
eParcel Korea.


INPOST_PACZKOMATY
InPost Paczkomaty.


IT_POSTE_ITALIA
Poste italiane (www.poste.it).


BE_BPOST
Bpost (www.bpost.be).


PL_POCZTA_POLSKA
Poczta Polska (www.poczta-polska.pl).


MYS_MYS_POST
Malaysia Post.


SG_SG_POST
Singapore Post.


THA_THAILAND_POST
Thailand Post (www.thailandpost.co.th).


LEXSHIP
LexShip.


FASTWAY_NZ
Fastway New Zealand.


DHL_AU
DHL Supply Chain Australia.


COSTMETICSNOW
Cosmetics Now.


PFLOGISTICS
PFL.


LOOMIS_EXPRESS
Loomis Express.


GLS_ITALY
GLS Italy.


LINE
Line Clear Express & Logistics Sdn Bhd.


GEL_EXPRESS
Gel Express Logistik.


HUODULL
Huodull.


NINJAVAN_SG
Ninja van Singapore.


JANIO
Janio Asia.


AO_COURIER
AO Logistics.


BRT_IT_SENDER_REF
BRT Bartolini(Sender Reference).


SAILPOST
SAILPOST.


LALAMOVE
Lalamove.


NEWZEALAND_COURIERS
NEW ZEALAND COURIERS.


ETOMARS
Etomars.


VIRTRANSPORT
VIR Transport.


WIZMO
Wizmo.


PALLETWAYS
Palletways.


I_DIKA
i-dika.


CFL_LOGISTICS
CFL Logistics.


GEMWORLDWIDE
GEM Worldwide.


GLOBAL_EXPRESS
Tai Wan Global Business.


LOGISTYX_TRANSGROUP
Transgroup courier.


WESTBANK_COURIER
West Bank Courier.


ARCO_SPEDIZIONI
Arco Spedizioni SP.


YDH_EXPRESS
YDH express.


PARCELINKLOGISTICS
Parcelink Logistics.


CNDEXPRESS
CND Express.


NOX_NIGHT_TIME_EXPRESS
NOX NightTimeExpress.


AERONET
Aeronet couriers.


LTIANEXP
LTIAN EXP.


INTEGRA2_FTP
Integra2.


PARCELONE
PARCEL ONE.


NOX_NACHTEXPRESS
Innight Express Germany GmbH (nox NachtExpress).


CN_CHINA_POST_EMS
China Post.


CHUKOU1
Chukou1.


GLS_SLOV
GLS General Logistics Systems Slovakia s.r.o..


ORANGE_DS
OrangeDS (Orange Distribution Solutions Inc).


JOOM_LOGIS
Joom Logistics.


AUS_STARTRACK
StarTrack (startrack.com.au).


DHL
dhl Global.


GB_APC
APC postal logistics germany.


BONDSCOURIERS
Bonds Courier Service (bondscouriers.com.au).


JPN_JAPAN_POST
Japan Post.


USPS
United States Postal Service.


WINIT
WinIt.


ARG_OCA
OCA Argentina.


TW_TAIWAN_POST
Taiwan Post.


DMM_NETWORK
DMM Network.


TNT
TNT Express.


BH_POSTA
BH Posta (www.posta.ba).


SWE_POSTNORD
Postnord sweden.


CA_CANADA_POST
Canada Post.


WISELOADS
Wiseloads.


ASENDIA_HK
Asendia HonKong.


NLD_GLS
GLS Netherland.


MEX_REDPACK
Redpack.


JET_SHIP
Jet-Ship Worldwide.


DE_DHL_EXPRESS
DHL Express.


NINJAVAN_THAI
Ninja van Thai.


RABEN_GROUP
Raben Group.


ESP_ASM
ASM(GLS Spain).


HRV_HRVATSKA
Hrvatska posta.


GLOBAL_ESTES
Estes Express Lines.


LTU_LIETUVOS
Lietuvos pastas.


BEL_DHL
DHL Benelux.


AU_AU_POST
Australia Post.


SPEEDEXCOURIER
SPEEDEX couriers.


FR_COLIS
Colissimo.


ARAMEX
Aramex.


DPEX
DPEX (www.dpex.com).


MYS_AIRPAK
Airpak Express.


CUCKOOEXPRESS
Cuckoo Express.


DPD_POLAND
DPD Poland.


NLD_POSTNL
PostNL International.


NIM_EXPRESS
Nim Express.


QUANTIUM
Quantium.


SENDLE
Sendle.


ESP_REDUR
Redur Spain.


MATKAHUOLTO
Matkahuolto.


CPACKET
Cpacket couriers.


POSTI
Posti courier.


HUNTER_EXPRESS
Hunter Express.


CHOIR_EXP
Choir Express Indonesia.


LEGION_EXPRESS
Legion Express.


AUSTRIAN_POST_EXPRESS
austrian post.


GRUPO
Grupo ampm.


POSTA_RO
Post Roman (www.posta-romana.ro).


INTERPARCEL_UK
Interparcel UK.


GLOBAL_ABF
ABF Freight.


POSTEN_NORGE
Posten Norge (www.posten.no).


XPERT_DELIVERY
Xpert Delivery.


DHL_REFR
DHl (Reference number).


DHL_HK
DHL HonKong.


SKYNET_UAE
SKYNET UAE.


GOJEK
Gojek.


YODEL_INTNL
Yodel International.


JANCO
Janco Ecommerce.


YTO
YTO Express.


WISE_EXPRESS
Wise Express.


JTEXPRESS_VN
J&T Express Vietnam.


FEDEX_INTL_MLSERV
FedEx International MailService.


VAMOX
VAMOX.


AMS_GRP
AMS Group.


DHL_JP
DHL Japan.


HRPARCEL
HR Parcel.


GESWL
GESWL Express.


BLUESTAR
Blue Star.


CDEK_TR
CDEK TR.


DESCARTES
Innovel courier.


DELTEC_UK
Deltec Courier.


DTDC_EXPRESS
DTDC express.


TOURLINE
tourline.


BH_WORLDWIDE
B&H Worldwide.


OCS
OCS ANA Group.


YINGNUO_LOGISTICS
yingnuo logistics.


UPS
United Parcel Service.


TOLL
Toll IPEC.


PRT_SEUR
SEUR portugal.


DTDC_AU
DTDC Australia.


THA_DYNAMIC_LOGISTICS
Dynamic Logistics.


UBI_LOGISTICS
UBI Smart Parcel.


FEDEX_CROSSBORDER
FedEx Cross Border.


A1POST
A1Post.


TAZMANIAN_FREIGHT
Tazmanian Freight Systems.


CJ_INT_MY
CJ International malaysia.


SAIA_FREIGHT
Saia LTL Freight.


SG_QXPRESS
Qxpress.


NHANS_SOLUTIONS
Nhans Solutions.


DPD_FR
DPD France.


COORDINADORA
Coordinadora.


ANDREANI
Grupo logistico Andreani.


DOORA
Doora Logistics.


INTERPARCEL_NZ
Interparcel New Zealand.


PHL_JAMEXPRESS
Jam Express Philippines.


BEL_BELGIUM_POST
bel_belgium_post.


US_APC
us_apc.


IDN_POS
idn_pos.


FR_MONDIAL
fr_mondial.


DE_DHL
DE DHL.


HK_RPX
hk_rpx.


DHL_PIECEID
dhl_pieceid.


VNPOST_EMS
vnpost_ems.


RRDONNELLEY
rrdonnelley.


DPD_DE
dpd_de.


DELCART_IN
delcart_in.


IMEXGLOBALSOLUTIONS
imexglobalsolutions.


ACOMMERCE
ACOMMERCE.


EURODIS
eurodis.


CANPAR
CANPAR.


GLS
GLS.


IND_ECOM
Ecom Express.


ESP_ENVIALIA
Envialia.


DHL_UK
dhl UK.


SMSA_EXPRESS
SMSA Express.


TNT_FR
TNT France.


DEX_I
DEX-I courier.


BUDBEE_WEBHOOK
Budbee courier.


COPA_COURIER
Copa Airlines Courier.


VNM_VIETNAM_POST
Vietnam Post.


DPD_HK
DPD HongKong.


TOLL_NZ
Toll New Zealand.


ECHO
Echo courier.


FEDEX_FR
FedEx® Freight.


BORDEREXPRESS
Border Express.


MAILPLUS_JPN
MailPlus (Japan).


TNT_UK_REFR
TNT UK Reference.


KEC
KEC courier.


DPD_RO
DPD Romania.


TNT_JP
TNT_JP.


TH_CJ
TH_CJ.


EC_CN
EC_CN.


FASTWAY_UK
FASTWAY_UK.


FASTWAY_US
FASTWAY_US.


GLS_DE
GLS_DE.


GLS_ES
GLS_ES.


GLS_FR
GLS_FR.


MONDIAL_BE
MONDIAL_BE.


SGT_IT
SGT_IT.


TNT_CN
TNT_CN.


TNT_DE
TNT_DE.


TNT_ES
TNT_ES.


TNT_PL
TNT_PL.


PARCELFORCE
PARCELFORCE.


SWISS_POST
SWISS POST.


TOLL_IPEC
TOLL IPEC.


AIR_21
AIR 21.


AIRSPEED
AIRSPEED.


BERT
BERT.


BLUEDART
BLUEDART.


COLLECTPLUS
COLLECTPLUS.


COURIERPLUS
COURIERPLUS.


COURIER_POST
COURIER POST.


DHL_GLOBAL_MAIL
dhl_global_mail.


DPD_UK
dpd_uk.


DELTEC_DE
DELTEC DE.


DEUTSCHE_DE
deutsche_de.


DOTZOT
DOTZOT.


ELTA_GR
elta_gr.


EMS_CN
ems_cn.


ECARGO
ECARGO.


ENSENDA
ENSENDA.


FERCAM_IT
fercam_it.


FASTWAY_ZA
fastway_za.


FASTWAY_AU
fastway_au.


FIRST_LOGISITCS
first_logisitcs.


GEODIS
GEODIS.


GLOBEGISTICS
GLOBEGISTICS.


GREYHOUND
GREYHOUND.


JETSHIP_MY
jetship_my.


LION_PARCEL
LION PARCEL.


AEROFLASH
AEROFLASH.


ONTRAC
ONTRAC.


SAGAWA
SAGAWA.


SIODEMKA
SIODEMKA.


STARTRACK
startrack.


TNT_AU
tnt_au.


TNT_IT
tnt_it.


TRANSMISSION
TRANSMISSION.


YAMATO
YAMATO.


DHL_IT
dhl_it.


DHL_AT
dhl_at.


LOGISTICSWORLDWIDE_KR
LOGISTICSWORLDWIDE KR.


GLS_SPAIN
gls_spain.


AMAZON_UK_API
amazon_uk_api.


DPD_FR_REFERENCE
dpd_fr_reference.


DHLPARCEL_UK
dhlparcel_uk.


MEGASAVE
megasave.


QUALITYPOST
qualitypost.


IDS_LOGISTICS
ids_logistics.


JOYINGBOX
joyingbox.


PANTHER_ORDER_NUMBER
panther_order_number.


WATKINS_SHEPARD
watkins_shepard.


FASTTRACK
fasttrack.


UP_EXPRESS
up_express.


ELOGISTICA
elogistica.


ECOURIER
ecourier.


CJ_PHILIPPINES
cj_philippines.


SPEEDEX
speedex.


ORANGECONNEX
orangeconnex.


TECOR
tecor.


SAEE
saee.


GLS_ITALY_FTP
gls_italy_ftp.


DELIVERE
delivere.


YYCOM
yycom.


ADICIONAL_PT
Adicional Logistics.


DKSH
DKSH.


NIPPON_EXPRESS_FTP
Nippon Express.


GOLS
GO Logistics & Storage.


FUJEXP
FUJIE EXPRESS.


QTRACK
QTrack.


OMLOGISTICS_API
OM LOGISTICS LTD.


GDPHARM
GDPharm Logistics.


MISUMI_CN
MISUMI Group Inc..


AIR_CANADA
Rivo.


CITY56_WEBHOOK
City Express.


SAGAWA_API
Sagawa.


KEDAEX
KedaEX.


PGEON_API
Pgeon.


WEWORLDEXPRESS
We World Express.


JT_LOGISTICS
J&T International logistics.


TRUSK
Trusk France.


VIAXPRESS
ViaXpress.


DHL_SUPPLYCHAIN_ID
DHL Supply Chain Indonesia.


ZUELLIGPHARMA_SFTP
Zuellig Pharma Korea.


MEEST
Meest.


TOLL_PRIORITY
Toll Priority.


MOTHERSHIP_API
Mothership.


CAPITAL
Capital Transport.


EUROPAKET_API
Europacket+.


HFD
HFD.


TOURLINE_REFERENCE
Tourline Express.


GIO_ECOURIER
GIO Express Inc.


CN_LOGISTICS
CN Logistics.


PANDION
Pandion.


BPOST_API
Bpost API.


PASSPORTSHIPPING
Passport Shipping.


PAKAJO
Pakajo World.


DACHSER
DACHSER.


YUSEN_SFTP
Yusen Logistics.


SHYPLITE
Shypmax.


XYY
Xingyunyi Logistics.


MWD
Metropolitan Warehouse & Delivery.


FAXECARGO
Faxe Cargo.


MAZET
Groupe Mazet.


FIRST_LOGISTICS_API
First Logistics.


SPRINT_PACK
SPRINT PACK.


HERMES_DE_FTP
Hermes Germany.


CONCISE
Concise.


KERRY_EXPRESS_TW_API
Kerry Express TaiWan.


EWE
EWE Global Express.


FASTDESPATCH
Fast Despatch Logistics Limited.


ABCUSTOM_SFTP
AB Custom Group.


CHAZKI
Chazki.


SHIPPIE
Shippie.


GEODIS_API
GEODIS - Distribution & Express.


NAQEL_EXPRESS
Naqel Express.


PAPA_WEBHOOK
Papa.


FORWARDAIR
Forward Air.


DIALOGO_LOGISTICA_API
Dialogo Logistica.


LALAMOVE_API
Lalamove.


TOMYDOOR
Tomydoor.


KRONOS_WEBHOOK
Kronos Express.


JTCARGO
J&T CARGO.


T_CAT
T-cat.


CONCISE_WEBHOOK
Concise.


TELEPORT_WEBHOOK
Teleport.


CUSTOMCO_API
The Custom Companies.


SPX_TH
Shopee Xpress.


BOLLORE_LOGISTICS
Bollore Logistics.


CLICKLINK_SFTP
ClickLink.


M3LOGISTICS
M3 Logistics.


VNPOST_API
Vietnam Post.


AXLEHIRE_FTP
Axlehire.


SHADOWFAX
Shadowfax.


MYHERMES_UK_API
EVRi.


DAIICHI
Daiichi Freight System Inc.


MENSAJEROSURBANOS_API
Mensajeros Urbanos.


POLARSPEED
PolarSpeed Inc.


IDEXPRESS_ID
iDexpress Indonesia.


PAYO
Payo.


WHISTL_SFTP
Whistl.


INTEX_DE
INTEX Paketdienst GmbH.


TRANS2U
Trans2u.


PRODUCTCAREGROUP_SFTP
Product Care Services Limited.


BIGSMART
Big Smart.


EXPEDITORS_API_REF
Expeditors API Reference.


AITWORLDWIDE_API
AIT.


WORLDCOURIER
World Courier.


QUIQUP
Quiqup.


AGEDISS_SFTP
Agediss.


ANDREANI_API
Andreani.


CRLEXPRESS
CRL Express.


SMARTCAT
SMARTCAT.


CROSSFLIGHT
Crossflight Limited.


PROCARRIER
Pro Carrier.


DHL_REFERENCE_API
DHL (Reference number).


SEINO_API
Seino.


WSPEXPRESS
WSP Express.


KRONOS
Kronos Express.


TOTAL_EXPRESS_API
Total Express.


PARCLL
PARCLL.


XPEDIGO
Xpedigo.


STAR_TRACK_WEBHOOK
StarTrack.


GPOST
Georgian Post.


UCS
UCS.


DMFGROUP
DMF.


COORDINADORA_API
Coordinadora.


MARKEN
Marken.


NTL
NTL logistics.


REDJEPAKKETJE
Red je Pakketje.


ALLIED_EXPRESS_FTP
Allied Express (FTP).


MONDIALRELAY_ES
Mondial Relay Spain(Punto Pack).


NAEKO_FTP
Naeko Logistics.


MHI
Mhi.


SHIPPIFY
Shippify, Inc.


MALCA_AMIT_API
Malca Amit.


JTEXPRESS_SG_API
J&T Express Singapore.


DACHSER_WEB
DACHSER.


FLIGHTLG
Flight Logistics Group.


CAGO
Cago.


COM1EXPRESS
ComOne Express.


TONAMI_FTP
Tonami.


PACKFLEET
PACKFLEET.


PUROLATOR_INTERNATIONAL
Purolator International.


WINESHIPPING_WEBHOOK
Wineshipping.


DHL_ES_SFTP
DHL Spain Domestic.


PCHOME_API
網家速配股份有限公司.


CESKAPOSTA_API
Czech Post.


GORUSH
Go Rush.


HOMERUNNER
HomeRunner.


AMAZON_ORDER
Amazon order.


EFWNOW_API
Estes Forwarding Worldwide.


CBL_LOGISTICA_API
CBL Logistica (API).


NIMBUSPOST
NimbusPost.


LOGWIN_LOGISTICS
Logwin Logistics.


NOWLOG_API
Sequoialog.


DPD_NL
DPD Netherlands.


GODEPENDABLE
Dependable Supply Chain Services.


ESDEX
Top Ideal Express.


LOGISYSTEMS_SFTP
Kiitäjät.


EXPEDITORS
Expeditors.


SNTGLOBAL_API
Snt Global Etrax.


SHIPX
ShipX.


QINTL_API
Quickstat Courier LLC.


PACKS
Packs.


POSTNL_INTERNATIONAL
PostNL International.


AMAZON_EMAIL_PUSH
Amazon.


DHL_API
DHL.


SPX
Shopee Express.


AXLEHIRE
AxleHire.


ICSCOURIER
ICS COURIER.


DIALOGO_LOGISTICA
Dialogo Logistica.


SHUNBANG_EXPRESS
ShunBang Express.


TCS_API
TCS.


SF_EXPRESS_CN
SF Express China.


PACKETA
Packeta.


SIC_TELIWAY
Teliway SIC Express.


MONDIALRELAY_FR
Mondial Relay France.


INTIME_FTP
InTime.


JD_EXPRESS
京东物流.


FASTBOX
Fastbox.


PATHEON
Patheon Logistics.


INDIA_POST
India Post Domestic.


TIPSA_REF
Tipsa Reference.


ECOFREIGHT
Eco Freight.


VOX
VOX SOLUCION EMPRESARIAL SRL.


DIRECTFREIGHT_AU_REF
Direct Freight Express.


BESTTRANSPORT_SFTP
Best Transport.


AUSTRALIA_POST_API
Australia Post.


FRAGILEPAK_SFTP
FragilePAK.


FLIPXP
FlipXpress.


VALUE_WEBHOOK
Value Logistics.


DAESHIN
Daeshin.


SHERPA
Sherpa.


MWD_API
Metropolitan Warehouse & Delivery.


SMARTKARGO
SmartKargo.


DNJ_EXPRESS
DNJ Express.


GOPEOPLE
Go People.


MYSENDLE_API
mySendle.


ARAMEX_API
Aramex.


PIDGE
Pidge.


THAIPARCELS
TP Logistic.


PANTHER_REFERENCE_API
Panther Reference.


POSTAPLUS
Posta Plus.


BUFFALO
BUFFALO.


U_ENVIOS
U-ENVIOS.


ELITE_CO
Elite Express.


ROCHE_INTERNAL_SFTP
Roche Internal Courier.


DBSCHENKER_ICELAND
DB Schenker Iceland.


TNT_FR_REFERENCE
TNT France Reference.


NEWGISTICSAPI
Newgistics API.


GLOVO
Glovo.


GWLOGIS_API
G.I.G.


SPREETAIL_API
Spreetail.


MOOVA
Moova.


PLYCONGROUP
Plycon Transportation Group.


USPS_WEBHOOK
USPS Informed Visibility - Webhook.


REIMAGINEDELIVERY
maergo.


EDF_FTP
Eurodifarm.


DAO365
DAO365.


BIOCAIR_FTP
BioCair.


RANSA_WEBHOOK
Ransa.


SHIPXPRES
SHIPXPRESS.


COURANT_PLUS_API
Courant Plus.


SHIPA
SHIPA.


HOMELOGISTICS
Home Logistics.


DX
DX.


POSTE_ITALIANE_PACCOCELERE
Poste Italiane Paccocelere.


TOLL_WEBHOOK
Toll Group.


LCTBR_API
LCT do Brasil.


DX_FREIGHT
DX Freight.


DHL_SFTP
DHL Express.


SHIPROCKET
Shiprocket X.


UBER_WEBHOOK
Uber.


STATOVERNIGHT
Stat Overnight.


BURD
Burd Delivery.


FASTSHIP
Fastship Express.


IBVENTURE_WEBHOOK
IB Venture.


GATI_KWE_API
Gati-KWE.


CRYOPDP_FTP
CryoPDP.


HUBBED
HUBBED.


TIPSA_API
Tipsa API.


ARASKARGO
Aras Cargo.


THIJS_NL
Thijs Logistiek.


ATSHEALTHCARE_REFERENCE
ATS Healthcare.


99MINUTOS
99minutos.


HELLENIC_POST
Hellenic (Greece) Post.


HSM_GLOBAL
HSM Global.


MNX
MNX.


NMTRANSFER
N&M Transfer Co., Inc..


LOGYSTO
Logysto.


INDIA_POST_INT
India Post International.


AMAZON_FBA_SWISHIP_IN
Swiship IN.


SRT_TRANSPORT
SRT Transport.


BOMI
Bomi Group.


DELIVERR_SFTP
Deliverr.


HSDEXPRESS
HSDEXPRESS.


SIMPLETIRE_WEBHOOK
SimpleTire.


HUNTER_EXPRESS_SFTP
Hunter Express.


UPS_API
UPS.


WOOYOUNG_LOGISTICS_SFTP
WOO YOUNG LOGISTICS CO.,LTD..


PHSE_API
PHSE.


WISH_EMAIL_PUSH
Wish.


NORTHLINE
Northline.


MEDAFRICA
Med Africa Logistics.


DPD_AT_SFTP
DPD Austria.


ANTERAJA
Anteraja.


DHL_GLOBAL_FORWARDING_API
DHL Global Forwarding API.


LBCEXPRESS_API
LBC EXPRESS INC..


SIMSGLOBAL
Sims Global.


CDLDELIVERS
CDL Last Mile.


TYP
TYP.


TESTING_COURIER_WEBHOOK
Testing Courier.


PANDAGO_API
Pandago.


ROYAL_MAIL_FTP
Royal Mail.


THUNDEREXPRESS
Thunder Express Australia.


SECRETLAB_WEBHOOK
Secretlab.


SETEL
Setel Express.


JD_WORLDWIDE
JD Worldwide.


DPD_RU_API
DPD Russia.


ARGENTS_WEBHOOK
Argents Express Group.


POSTONE
Post ONE.


TUSKLOGISTICS
Tusk Logistics.


RHENUS_UK_API
Rhenus Logistics UK.


TAQBIN_SG_API
Yamato Singapore.


INNTRALOG_SFTP
Inntralog GmbH.


DAYROSS
Day & Ross.


CORREOSEXPRESS_API
Correos Express (API).


INTERNATIONAL_SEUR_API
International Seur API.


YODEL_API
Yodel API.


HEROEXPRESS
Hero Express.


DHL_SUPPLYCHAIN_IN
DHL supply chain India.


URGENT_CARGUS
Urgent Cargus.


FRONTDOORCORP
FRONTdoor Collective.


JTEXPRESS_PH
J&T Express Philippines.


PARCELSTARS_WEBHOOK
Parcelstars.


DPD_SK_SFTP
DPD Slovakia.


MOVIANTO
Movianto.


OZEPARTS_SHIPPING
Ozeparts Shipping.


KARGOMKOLAY
KargomKolay (CargoMini).


TRUNKRS
Trunkrs.


OMNIRPS_WEBHOOK
Omni Returns.


CHILEXPRESS
Chile Express.


TESTING_COURIER
Testing Courier.


JNE_API
JNE (API).


BJSHOMEDELIVERY_FTP
BJS Distribution, Storage & Couriers - FTP.


DEXPRESS_WEBHOOK
D Express.


USPS_API
USPS API.


TRANSVIRTUAL
TransVirtual.


SOLISTICA_API
solistica.


CHIENVENTURE_WEBHOOK
Chienventure.


DPD_UK_SFTP
DPD UK.


INPOST_UK
InPost.


JAVIT
Javit.


ZTO_DOMESTIC
ZTO Express China.


DHL_GT_API
DHL Global Forwarding Guatemala.


CEVA_TRACKING
CEVA Package.


KOMON_EXPRESS
Komon Express.


EASTWESTCOURIER_FTP
East West Courier Pte Ltd.


DANNIAO
Danniao.


SPECTRAN
Spectran.


DELIVER_IT
Deliver-iT.


RELAISCOLIS
Relais Colis.


GLS_SPAIN_API
GLS Spain.


POSTPLUS
PostPlus.


AIRTERRA
Airterra.


GIO_ECOURIER_API
GIO Express Ecourier.


DPD_CH_SFTP
DPD Switzerland.


FEDEX_API
FedEx®.


INTERSMARTTRANS
INTERSMARTTRANS & SOLUTIONS SL.


HERMES_UK_SFTP
Hermes UK.


EXELOT_FTP
Exelot Ltd..


DHL_PA_API
DHL GLOBAL FORWARDING PANAMÁ.


VIRTRANSPORT_SFTP
Vir Transport.


WORLDNET
Worldnet Logistics.


INSTABOX_WEBHOOK
Instabox.


KNG
Keuhne + Nagel Global.


FLASHEXPRESS_WEBHOOK
Flash Express.


MAGYAR_POSTA_API
Magyar Posta.


WESHIP_API
WeShip.


OHI_WEBHOOK
Ohi.


MUDITA
MUDITA.


BLUEDART_API
Bluedart.


T_CAT_API
T-cat.


ADS
ADS Express.


HERMES_IT
HR Parcel.


FITZMARK_API
FitzMark.


POSTI_API
Posti API.


SMSA_EXPRESS_WEBHOOK
SMSA Express.


TAMERGROUP_WEBHOOK
Tamer Logistics.


LIVRAPIDE
Livrapide.


NIPPON_EXPRESS
Nippon Express.


BETTERTRUCKS
Better Trucks.


FAN
FAN COURIER EXPRESS.


PB_USPSFLATS_FTP
USPS Flats (Pitney Bowes).


PARCELRIGHT
Parcel Right.


ITHINKLOGISTICS
iThink Logistics.


KERRY_EXPRESS_TH_WEBHOOK
Kerry Logistics.


ECOUTIER
eCoutier.


SHOWL
SENHONG INTERNATIONAL LOGISTICS.


BRT_IT_API
BRT Bartolini API.


RIXONHK_API
Rixon Logistics.


DBSCHENKER_API
DB Schenker.


ILYANGLOGIS
Ilyang logistics.


MAIL_BOX_ETC
Mail Boxes Etc..


WESHIP
WeShip.


DHL_GLOBAL_MAIL_API
DHL eCommerce Solutions.


ACTIVOS24_API
Activos24.


ATSHEALTHCARE
ATS Healthcare.


LUWJISTIK
Luwjistik.


GW_WORLD
Gebrüder Weiss.


FAIRSENDEN_API
fairsenden.


SERVIP_WEBHOOK
SerVIP.


SWISHIP
Swiship.


TANET
Transport Ambientales.


HOTSIN_CARGO
SHENZHEN HOTSIN CARGO INT'L FORWARDING CO.,LTD.


DIREX
Direx.


HUANTONG
HuanTong.


IMILE_API
iMile.


AUEXPRESS
Au Express.


NYTLOGISTICS
NYT SUPPLY CHAIN LOGISTICS Co.,LTD.


DSV_REFERENCE
DSV Futurewave.


NOVOFARMA_WEBHOOK
Novofarma.


AITWORLDWIDE_SFTP
AIT.


SHOPOLIVE
Olive.


FNF_ZA
Fast & Furious.


DHL_ECOMMERCE_GC
DHL eCommerce Greater China.


FETCHR
Fetchr.


STARLINKS_API
Starlinks Global.


YYEXPRESS
YYEXPRESS.


SERVIENTREGA
Servientrega.


HANJIN
HanJin.


SPANISH_SEUR_FTP
Spanish Seur.


DX_B2B_CONNUM
DX (B2B).


HELTHJEM_API
Helthjem.


INEXPOST
Inexpost.


A2B_BA
A2B Express Logistics.


RHENUS_GROUP
Rhenus Logistics.


SBERLOGISTICS_RU
Sber Logistics.


MALCA_AMIT
Malca-Amit.


PPL
Professional Parcel Logistics.


OSM_WORLDWIDE_SFTP
OSM Worldwide.


ACILOGISTIX
ACI Logistix.


OPTIMACOURIER
Optima Courier.


NOVA_POSHTA_API
Nova Poshta API.


LOGGI
Loggi.


YIFAN
YiFan Express.


MYDYNALOGIC
My DynaLogic.


MORNINGLOBAL
Morning Global.


CONCISE_API
Concise.


FXTRAN
Falcon Express.


DELIVERYOURPARCEL_ZA
Deliver Your Parcel.


UPARCEL
uParcel.


MOBI_BR
Mobi Logistica.


LOGINEXT_WEBHOOK
T&W Delivery.


EMS
EMS.


SPEEDY
Speedy.


ZOOM_RED
Zoom.


NAVLUNGO
Navlungo.


CASTLEPARCELS
Castle Parcels.


WEEE
Weee.


PACKALY
Packaly.


YUNHUIPOST
Yunhuipost.


YOUPARCEL
YouParcel.


LEMAN
Leman.


MOOVIN
Moovin.


URB_IT
Urb-it.


MULTIENTREGAPANAMA
Multientrega.


JUSDASR
Jusdasr.


DISCOUNTPOST
Discount Post.


RHENUS_UK
Rhenus Logistics UK.


SWISHIP_JP
Swiship JP.


GLS_US
GLS USA.


SMTL
Southwestern Motor Transport. Inc.


EMEGA
Discount Post Emega.


EXPRESSONE_SV
EXPRESSONE Slovenia.


HEPSIJET
hepsiJET.


WELIVERY
Welivery.


BRINGER
Bringer Parcel Services.


EASYROUTES
EasyRoutes.


MRW
MRW.


RPM
RPM.


DPD_PRT
DPD Portugal.


GLS_ROMANIA
GLS Romania.


LMPARCEL
LM Parcel.


GTAGSM
GTA GSM.


DOMINO
DOMINO.


ESHIPPER
eShipper.


TRANSPAK
Transpak Inc..


XINDUS
Xindus.


AOYUE
Aoyue.


EASYPARCEL
Easyparcel.


EXPRESSONE
EXPRESSONE.


SENDEO_KARGO
Sendeo Kargo.


SPEEDAF
Speedaf Express.


ETOWER
eTower.


GCX
GC Express.


NINJAVAN_VN
Ninjavan Vietnam.


ALLEGRO
Allegro.


JUMPPOINT
Jumppoint.


SHIPGLOBAL_US
ShipGlobal.


KINISI
Kinisi Transport Pty Ltd.


OAKH
Oakh Harbour Freight Lines.


AWEST
American West.


BARSAN
Barsan Global Lojistik.


ENERGOLOGISTIC
Energo Logistic.


MADROOEX
Madrooex.


GOBOLT
GoBolt.


SWISS_UNIVERSAL_EXPRESS
Swiss Universal Express.


IORDIRECT
IOR Direct Solutions.


XMSZM
xmszm.


GLS_HUN
GLS Hungary.


SENDY
Sendy Express.


BRAUNSEXPRESS
Brauns Express.


GRANDSLAMEXPRESS
Grand Slam Express.


XGS
XGS.


OTSCHILE
OTS.


PACK_UP
Pack-Up.


PARCELSTARS
Parcelstars.


TEAMEXPRESSLLC
Team Express Service LLC.


ASYADEXPRESS
Asyad Express.


TDN
TDN.


EARLYBIRD
Early Bird.


CACESA
Cacesa.


PARCELJET
Parceljet.


MNG_KARGO
MNG Kargo.


SUPERPACKLINE
Super Pac Line.


SPEEDX
SpeedX.


VESYL
Vesyl.


SKYKING
Sky King.


DIRMENSAJERIA
DIR.


NETLOGIXGROUP
Netlogix.


ZYOU
ZYEX.


JAWAR
Jawar.


AGSYSTEMS
Associate Global Systems.


GPS
GPS.


PTT_KARGO
PTT Kargo.


MAERGO
Maergo.


ARIHANTCOURIER
AICS.


VTFE
VicTas Freight Express.


YUNANT
Yunant.


URBIFY
Urbify.


PACK_MAN
pack-man.


LIEFERGRUN
LIEFERGRUN.


OBIBOX
Obibox.


PAIKEDA
Paikeda.


SCOTTY
Scotty.


INTELCOM_CA
Intelcom.


SWE
swe.


ASENDIA
Asendia Global.


DPD_AT
DPD Austria.


RELAY
Relay.


ATA
ATA.


SKYEXPRESS_INTERNATIONAL
SkyExpress Internationals.


SURAT_KARGO
Surat Kargo.


SGLINK
SG LINK.


FLEETOPTICSINC
FleetOptics.


SHOPLINE
shopline.


PIGGYSHIP
PIGGYSHIP.


LOGOIX
LogoiX.


KOLAY_GELSIN
Kolay Gelsin.


ASSOCIATED_COURIERS
Associated Couriers.


UPS_CHECKER
ups-checker.


WINESHIPPING
Wineshipping.


SPEDISCI
Spedisci online.


 
capture_id
required
string  [ 1 .. 50 ] characters ^[a-zA-Z0-9]*$
The PayPal capture ID.


 
notify_payer
boolean
 Default:  false
If true, PayPal will send an email notification to the payer of the PayPal transaction. The email contains the tracking details provided through the Orders tracking API request. Independent of any value passed for notify_payer, the payer may receive tracking notifications within the PayPal app, based on the user's notification preferences.


 
Array of objects (tracker_item) 
An array of details of items in the shipment.


 
{
  • "tracking_number": "string",
  • "carrier_name_other": "string",
  • "carrier": "DPD_RU",
  • "capture_id": "string",
  • "notify_payer": false,
  • "items": []
}
tracking_number_type
The tracking number type.


string (tracking_number_type)   [ 1 .. 64 ] characters ^[0-9A-Z_]+$
The tracking number type.


 Enum Value Description
CARRIER_PROVIDED
A carrier-provided tracking number.


E2E_PARTNER_PROVIDED
A marketplace-provided tracking number.


 
"CARRIER_PROVIDED"
tracking_status
The status of the item shipment. For allowed values, see Shipping Statuses.


string (tracking_status)   [ 1 .. 64 ] characters ^[0-9A-Z_]+$
The status of the item shipment. For allowed values, see Shipping Statuses.


 Enum Value Description
CANCELLED
The shipment was cancelled and the tracking number no longer applies.


DELIVERED
The item was already delivered when the tracking number was uploaded.


LOCAL_PICKUP
Either the buyer physically picked up the item or the seller delivered the item in person without involving any couriers or postal companies.


ON_HOLD
The item is on hold. Its shipment was temporarily stopped due to bad weather, a strike, customs, or another reason.


SHIPPED
The item was shipped and is on the way.


 
"CANCELLED"
trustly
Information needed to pay using Trustly.


name
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
email
string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The email address of the account holder associated with this payment method.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The bank identification code (BIC).


 
iban_last_chars
string (iban_last_chars)   [ 4 .. 34 ] characters [a-zA-Z0-9]{4}
The last characters of the IBAN used to pay.


 
{
  • "name": "string",
  • "country_code": "string",
  • "email": "string",
  • "bic": "string",
  • "iban_last_chars": "string"
}
trustly_request
Information needed to pay using Trustly.


name
required
string (name)   [ 3 .. 300 ] characters 
The name of the account holder associated with this payment method.


 
country_code
required
string <ppaas_common_country_code_v2>  (country_code)   = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.


 
email
required
string <ppaas_common_email_address_v2>  (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
The email address of the account holder associated with this payment method.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "email": "string",
  • "experience_context": {
    • "brand_name": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "locale": "string",
    • "return_url": "string",
    • "cancel_url": "string"
    }
}
universal_product_code
The Universal Product Code of the item.


type
required
string (Universal Product Code Type)   [ 1 .. 5 ] characters ^[0-9A-Z_-]+$
The Universal Product Code type.


 Enum Value Description
UPC-A
N/A


UPC-B
N/A


UPC-C
N/A


UPC-D
N/A


UPC-E
N/A


UPC-2
N/A


UPC-5
N/A


 
code
required
string  [ 6 .. 17 ] characters ^[0-9]{0,17}$
The UPC product code of the item.


 
{
  • "type": "UPC-A",
  • "code": "string"
}
url
Describes the URL.


string <uri>  (url) 
Describes the URL.


 
"http://example.com"
uuid
The universally unique identifier (UUID) in Universally Unique IDentifier (UUID) URN Namespace format.


string <ppaas_uuid_v3>  (uuid)   = 36 characters ^[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}...
The universally unique identifier (UUID) in Universally Unique IDentifier (UUID) URN Namespace format.


 
"stringstringstringstringstringstring"
v3_vault_instruction_base
Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting.


store_in_vault
required
string (store_in_vault_instruction)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Defines how and when the payment source gets vaulted.


 Value Description
ON_SUCCESS
Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful.


 
{
  • "store_in_vault": "ON_SUCCESS"
}
vault_id
The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.


string (vault_id)   [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.


 
"string"
vault_instruction_base
Basic vault instruction specification that can be extended by specific payment sources that supports vaulting.


store_in_vault
string (store_in_vault_instruction)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Defines how and when the payment source gets vaulted.


 Value Description
ON_SUCCESS
Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful.


 
{
  • "store_in_vault": "ON_SUCCESS"
}
vault_paypal_wallet_base
Resource consolidating common request and response attributes for vaulting PayPal Wallet.


store_in_vault
string (store_in_vault_instruction)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Defines how and when the payment source gets vaulted.


 Value Description
ON_SUCCESS
Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful.


 
description
string  [ 1 .. 128 ] characters 
The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the PayPal payment token management experience on PayPal.com.


 
usage_pattern
string (PayPal Payment Token Usage Pattern)   [ 1 .. 30 ] characters 
Expected business/pricing model for the billing agreement.


 
usage_type
required
string (PayPal Payment Token Usage Type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The usage type associated with the PayPal payment token.


 
customer_type
string (PayPal Payment Token Customer Type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
 Default:  "CONSUMER"
The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.


 
permit_multiple_payment_tokens
boolean
 Default:  false
Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.


 
{
  • "store_in_vault": "ON_SUCCESS",
  • "description": "string",
  • "usage_pattern": "string",
  • "usage_type": "string",
  • "customer_type": "CONSUMER",
  • "permit_multiple_payment_tokens": false
}
vault_response
The details about a saved payment source.


id
string  [ 1 .. 255 ] characters 
The PayPal-generated ID for the saved payment source.


 
status
string (Vault Status)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The vault status.


 Enum Value Description
VAULTED
The payment source has been saved in your customer's vault. This vault status reflects /v3/vault status.


CREATED
DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations.


APPROVED
Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault


 
Array of objects (Link Description)   [ 1 .. 10 ] items 
An array of request-related HATEOAS links.


 
{
  • "id": "string",
  • "status": "VAULTED",
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ]
}
vault_response
The details about a saved payment source.


id
string  [ 1 .. 255 ] characters 
The PayPal-generated ID for the saved payment source.


 
status
string (Vault Status)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The vault status.


 Enum Value Description
VAULTED
The payment source has been saved in your customer's vault. This vault status reflects /v3/vault status.


CREATED
DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations.


APPROVED
Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault


 
Array of objects (Link Description)   [ 1 .. 10 ] items 
An array of request-related HATEOAS links.


 
{
  • "id": "string",
  • "status": "VAULTED",
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ]
}
vault_response
The details about a saved payment source.


id
string  [ 1 .. 255 ] characters 
The PayPal-generated ID for the saved payment source.


 
status
string (Vault Status)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The vault status.


 Enum Value Description
VAULTED
The payment source has been saved in your customer's vault. This vault status reflects /v3/vault status.


CREATED
DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations.


APPROVED
Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault


 
Array of objects (Link Description)   [ 1 .. 10 ] items 
An array of request-related HATEOAS links.


 
object (customer) 
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.


 
{
  • "id": "string",
  • "status": "VAULTED",
  • "links": [
    • {
      • "href": "string",
      • "rel": "string",
      • "method": "GET"
      }
    ],
  • "customer": {
    • "id": "string",
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      }
    }
}
vault_Venmo_wallet_base
Resource consolidating common request and response attirbutes for vaulting Venmo Wallet.


store_in_vault
required
string (store_in_vault_instruction)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Defines how and when the payment source gets vaulted.


 Value Description
ON_SUCCESS
Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful.


 
description
string  [ 1 .. 128 ] characters ^[a-zA-Z0-9_'\-., :;\!?"]*$
The description displayed to Venmo consumer on the approval flow for Venmo, as well as on the Venmo payment token management experience on Venmo.com.


 
usage_pattern
string (Venmo Payment Token Usage Pattern)   [ 1 .. 30 ] characters ^[0-9A-Z_]+$
Expected business/pricing model for the billing agreement.


 
usage_type
required
string (Venmo Payment Token Usage Type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The usage type associated with the Venmo payment token.


 
customer_type
string (Venmo Payment Token Customer Type)   [ 1 .. 255 ] characters ^[0-9A-Z_]+$
 Default:  "CONSUMER"
The customer type associated with the Venmo payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.


 
permit_multiple_payment_tokens
boolean
 Default:  false
Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same Venmo account.


 
{
  • "store_in_vault": "ON_SUCCESS",
  • "description": "string",
  • "usage_pattern": "string",
  • "usage_type": "string",
  • "customer_type": "CONSUMER",
  • "permit_multiple_payment_tokens": false
}
venmo_wallet_attributes
Additional attributes associated with the use of this Venmo Wallet.


object (customer) 
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.


 
object (vault_Venmo_wallet_base) 
Attributes used to provide the instructions during vaulting of the Venmo Wallet.


 
{
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "given_name": "string",
      • "surname": "string"
      }
    },
  • "vault": {
    • "store_in_vault": "ON_SUCCESS",
    • "description": "string",
    • "usage_pattern": "string",
    • "usage_type": "string",
    • "customer_type": "CONSUMER",
    • "permit_multiple_payment_tokens": false
    }
}
venmo_wallet_attributes_response
Additional attributes associated with the use of a Venmo Wallet.


object (vault_response) 
The details about a saved payment source.


 
{
  • "vault": {
    • "id": "string",
    • "status": "VAULTED",
    • "links": [
      • {
        • "href": "string",
        • "rel": "string",
        • "method": "GET"
        }
      ],
    • "customer": {
      • "id": "string",
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        }
      }
    }
}
venmo_wallet_experience_context
Customizes the buyer experience during the approval process for payment with Venmo.
Note: Partners and Marketplaces might configure shipping_preference during partner account setup, which overrides the request values.


brand_name
string  [ 1 .. 127 ] characters ^.*$
The business name of the merchant. The pattern is defined by an external party and supports Unicode.


 
shipping_preference
string  [ 1 .. 24 ] characters ^[A-Z_]+$
 Default:  "GET_FROM_FILE"
The location from which the shipping address is derived.


 Enum Value Description
GET_FROM_FILE
Get the customer-provided shipping address on the PayPal site.


NO_SHIPPING
Redacts the shipping address from the PayPal site. Recommended for digital goods.


SET_PROVIDED_ADDRESS
Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages.


 
object (callback_configuration) 
Merchant provided Order Update callback configuration for Venmo Wallet.Venmo will call back merchant when the specified event occurs.we recommend merchants to pass both the shipping_options and shipping_address callback events. Not supported when shipping.type is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.


 
{
  • "brand_name": "string",
  • "shipping_preference": "GET_FROM_FILE",
  • "order_update_callback_config": {}
}
venmo_wallet_request
Information needed to pay using Venmo.


object (venmo_wallet_experience_context) 
Customizes the buyer experience during the approval process for payment with Venmo.
Note: Partners and Marketplaces might configure shipping_preference during partner account setup, which overrides the request values.


 
vault_id
string (vault_id)   [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the saved Venmo wallet payment_source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.


 
email_address
string <merchant_common_email_address_v2>  (email)   [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...
The email address of the payer.


 
object (venmo_wallet_attributes) 
Additional attributes associated with the use of this wallet.


 
{
  • "experience_context": {
    • "brand_name": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "order_update_callback_config": {}
    },
  • "vault_id": "string",
  • "email_address": "string",
  • "attributes": {
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "given_name": "string",
        • "surname": "string"
        }
      },
    • "vault": {
      • "store_in_vault": "ON_SUCCESS",
      • "description": "string",
      • "usage_pattern": "string",
      • "usage_type": "string",
      • "customer_type": "CONSUMER",
      • "permit_multiple_payment_tokens": false
      }
    }
}
venmo_wallet_response
Venmo wallet response.


user_name
string  [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]*$
The Venmo user name chosen by the user, also know as a Venmo handle.


 
object (venmo_wallet_attributes_response) 
Additional attributes associated with the use of a Venmo Wallet.


 
email_address
string <merchant_common_email_address_v2>  (email)   [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...
The email address of the payer.


 
account_id
string <ppaas_payer_id_v3>  (account_id)   = 13 characters ^[2-9A-HJ-NP-Z]{13}$
This is an immutable system-generated id for a user's Venmo account.


 
object (Name) 
The name associated with the Venmo account. Supports only the given_name and surname properties.


 
object (Phone Number) 
The phone number associated with the Venmo account, in its canonical international E.164 numbering plan format. Supports only the national_number property.


 
object (Portable Postal Address (Medium-Grained)) 
The address of the payer. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer.


 
{
  • "user_name": "string",
  • "attributes": {
    • "vault": {
      • "id": "string",
      • "status": "VAULTED",
      • "links": [
        • {
          • "href": "string",
          • "rel": "string",
          • "method": "GET"
          }
        ],
      • "customer": {
        • "id": "string",
        • "name": {
          • "given_name": "string",
          • "surname": "string"
          }
        }
      }
    },
  • "email_address": "string",
  • "account_id": "stringstrings",
  • "name": {
    • "given_name": "string",
    • "surname": "string"
    },
  • "phone_number": {
    • "national_number": "string"
    },
  • "address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st"
    }
}