The PreAuthorization object

The PreAuthorization object ensures the solvency of a registered card for 7 days. The overall process is as follows:

  1. Register a card (CardRegistration)
  2. Create a PreAuthorization with the CardId. This allows you to charge an amount on a card.
  3. Charge the card using the Card PreAuthorized PayIn (payins/preauthorized/direct)

How does PreAuthorization work?

  • Once the PreAuthorization object is created the Status is "CREATED" until 3D secure validation.
  • If the authorization is successful the status is "SUCCEEDED" if it failed the status is "FAILED".
  • Once Status = "SUCCEEDED" and PaymentStatus = "WAITING" you can charge the card.
  • The pay-in amount has to be less than or equal to the amount authorized.
  • There is no limit to the number of captures that can be made, so long as each of these is valid.

For more information on making multiple pay-ins against a pre-authorization, please refer to Multi-capture.

Multiple captures are only possible with the payment method CB/Visa/Mastercard.

In Italy, Greece and Spain, the pre-authorization has a particular running. In fact, the pre-authorized amount is debited from the bank account. Pre-authorized funds are stored by the bank. The user will get his/her funds back within 7 days. This case appears on several Banks (we don’t have exhaustive list) in Spain, Italy and Greece. Mangopay recommends you to inform your users or only create €1.00 pre-authorizations in these countries.

Note that a preauthorization is automatically cancelled after the ExpirationDate if you do not cancel it yourself, nor do a pay-in with it

Parameters

AuthorId
string

string:

Maximum length is 255 characters

A user's ID

DebitedFunds
MoneyCard

MoneyCard:

View Sub-parameters

Information about the funds that are being debited

DebitedFunds.Currency
CurrencyCard

CurrencyCard:

AED, AUD, CAD, CHF, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR

The currency of the card payment - should be ISO_4217 format

DebitedFunds.Amount
int

int

An amount of money in the smallest sub-division of the currency, e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY would be represented as just 12)

RemainingFunds
MoneyCard

MoneyCard:

View Sub-parameters

Value of the funds remaining on a pre-authorization

RemainingFunds.Currency
CurrencyCard

CurrencyCard:

AED, AUD, CAD, CHF, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR

The currency of the card payment - should be ISO_4217 format

RemainingFunds.Amount
int

int

An amount of money in the smallest sub-division of the currency, e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY would be represented as just 12)

Status
PreAuthorizationStatus

PreAuthorizationStatus:

CREATED , SUCCEEDED, FAILED

The status of the preauthorization

Status of the PreAuthorization

PaymentStatus
PaymentStatus

PaymentStatus:

WAITING, CANCELED, EXPIRED, VALIDATED

The status of the payment for a preauthorization or a deposit preauthorization

The status of the payment after the PreAuthorization. You can pass the PaymentStatus from "WAITING" to "CANCELED" should you need/want to

ResultCode
string

string:

Maximum length is 255 characters

The result code

ResultMessage
string

string:

Maximum length is 255 characters

A verbal explanation of the ResultCode

ExecutionType
PreAuthorizationExecutionType

PreAuthorizationExecutionType:

DIRECT

The execution type for a preauthorization

How the PreAuthorization has been executed

SecureMode
SecureMode

SecureMode:

DEFAULT, FORCE, NO_CHOICE

The SecureMode is used to select a 3DS1 and 3DS2 protocol for CB Visa and MasterCard. The field lets you ask for an Frictionless payment with the value "DEFAULT". The value "NO_CHOICE" will allow you to make the transaction eligible for Frictionless, but the exemption will be applied by the other payment actors. The value force "FORCE"will force customer authentification.

CardId
string

string:

Maximum length is 255 characters

The ID of a card

SecureModeNeeded
bool

bool:

true, false

The value is 'true' if the SecureMode was used

SecureModeRedirectURL
string

string:

Maximum length is 255 characters

This is the URL where to redirect users to proceed to 3D secure validation

SecureModeReturnURL
string

string:

Maximum length is 255 characters

This is the URL where users are automatically redirected after 3D secure validation (if activated)

ExpirationDate
timestamp

timestamp

The date when the payment is to be processed by

PayInId
string

string:

Maximum length is 255 characters

The Id of the associated PayIn

Billing
Billing

Billing:

View Sub-parameters

Contains every useful informations related to the user billing

Billing.FirstName
string

string:

Maximum length is 255 characters

The name of the user.

Billing.LastName
string

string:

Maximum length is 255 characters

The last name of the user.

Billing.Address
Address

Address:

View Sub-parameters

The address

Billing.Address.AddressLine1
string

string:

Maximum length is 255 characters

The first line of the address

Billing.Address.AddressLine2
string

string:

Maximum length is 255 characters

The second line of the address

Billing.Address.City
string

string:

Maximum length is 255 characters

The city of the address

Billing.Address.Region
string

string:

Maximum length is 255 characters

The region of the address - this is optional except if the Country is US, CA or MX

Billing.Address.PostalCode
string

string:

Maximum length is 50 characters

The postal code of the address - can be alphanumeric, dashes or spaces

Billing.Address.Country
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

The Country of the Address

SecurityInfo
SecurityInfo

SecurityInfo:

View Sub-parameters

Contains useful informations related to security and fraud

SecurityInfo.AVSResult
AVSResult

AVSResult:

NO_CHECK, NO_MATCH, ADDRESS_MATCH_ONLY, POSTAL_CODE_MATCH_ONLY, FULL_MATCH

Result of Address Verification System check (only available for UK, US and Australia)

Culture
CultureCode

CultureCode:

DE, EN, DA, ES, ET, FI, FR, EL, HU, IT, NL, NO, PL, PT, SK, SV, CS

The language to use for the payment webpage

The language to use for the payment page - needs to be the ISO code of the language

MultiCapture
bool

bool:

true, false

Indicates wether this feature is active

IpAddress
string

string:

Maximum length is 255 characters

IP Address of the end user (format IPV4 or IPV6)

BrowserInfo
BrowserInfo

BrowserInfo:

This object describes the Browser being user by an end user

View Sub-parameters

This object describes the Browser being user by an end user

BrowserInfo.AcceptHeader
string

string:

Maximum length is 255 characters

Exact content of the HTTP accept headers as sent to the merchant from the shopper’s browser

BrowserInfo.JavaEnabled
bool

bool:

true, false

Whether the user browser has Java enabled

BrowserInfo.Language
string

string:

Maximum length is 255 characters

Language of the browser of the user

BrowserInfo.ColorDepth
int

int

Value representing the bit depth of the colour palette for displaying images, in bits per pixel

BrowserInfo.ScreenHeight
int

int

The height of the screen in pixels

BrowserInfo.ScreenWidth
int

int

The width of the screen in pixels

BrowserInfo.TimeZoneOffset
int

int

UTC time offset in minutes

BrowserInfo.UserAgent
string

string:

Maximum length is 255 characters

Exact content of the HTTP user-agent header

BrowserInfo.JavascriptEnabled
bool

bool:

true, false

Whether the browser is Javascript enabled

Shipping
Shipping

Shipping:

View Sub-parameters

Contains every useful information's related to the user shipping

Shipping.FirstName
string

string:

Maximum length is 100 characters

The name of the user.

Shipping.LastName
string

string:

Maximum length is 100 characters

The last name of the user.

Shipping.Address
Address

Address:

View Sub-parameters

The address

Shipping.Address.AddressLine1
string

string:

Maximum length is 255 characters

The first line of the address

Shipping.Address.AddressLine2
string

string:

Maximum length is 255 characters

The second line of the address

Shipping.Address.City
string

string:

Maximum length is 255 characters

The city of the address

Shipping.Address.Region
string

string:

Maximum length is 255 characters

The region of the address - this is optional except if the Country is US, CA or MX

Shipping.Address.PostalCode
string

string:

Maximum length is 50 characters

The postal code of the address - can be alphanumeric, dashes or spaces

Shipping.Address.Country
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

The Country of the Address

{
"AuthorId": "8494514",
"DebitedFunds": {
"Currency": "lorem",
"Amount": 1260
},
"RemainingFunds": {
"Currency": "lorem",
"Amount": 1260
},
"Status": "CREATED",
"PaymentStatus": "WAITING",
"ResultCode": "000000",
"ResultMessage": "The transaction was successful",
"ExecutionType": "DIRECT",
"SecureMode": "DEFAULT",
"CardId": "14213157",
"SecureModeNeeded": false,
"SecureModeRedirectURL": "http://www.a-url.com/3DS-redirect",
"SecureModeReturnURL": "http://www.my-site.com/returnURL",
"ExpirationDate": 1463495916,
"PayInId": "12639163",
"Billing": {
"FirstName": "Joe",
"LastName": "Blogs",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
},
"SecurityInfo": {
"AVSResult": "NO_CHECK"
},
"Culture": "EN",
"MultiCapture": True,
"IpAddress": "2001:0620:0000:0000:0211:24FF:FE80:C12C",
"BrowserInfo": {
"AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
"JavaEnabled": true,
"Language": "FR-FR",
"ColorDepth": 4,
"ScreenHeight": 1800,
"ScreenWidth": 400,
"TimeZoneOffset": 60,
"UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
"JavascriptEnabled": true
},
"Shipping": {
"FirstName": "Joe",
"LastName": "Blogs",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
}
}

Create a PreAuthorization

Note that if you do not cancel the preauthorization yourself, nor do a payin with the preauth, we will automatically cancel it for you after the ExpirationDate

POST .../v2.01/ClientId

The ID of your client account

/preauthorizations/card/direct

Parameters

AuthorId
string

string:

Maximum length is 255 characters

required

A user's ID

DebitedFunds
MoneyCard

MoneyCard:

View Sub-parameters

required

Information about the funds that are being debited

DebitedFunds.Currency
CurrencyCard

CurrencyCard:

AED, AUD, CAD, CHF, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR

required

The currency of the card payment - should be ISO_4217 format

DebitedFunds.Amount
int

int

required

An amount of money in the smallest sub-division of the currency, e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY would be represented as just 12)

Billing
Billing

Billing:

View Sub-parameters

optional

Contains every useful informations related to the user billing

Billing.FirstName
string

string:

Maximum length is 255 characters

required

The name of the user.

Billing.LastName
string

string:

Maximum length is 255 characters

required

The last name of the user.

Billing.Address
Address

Address:

View Sub-parameters

required

The address

Billing.Address.AddressLine1
string

string:

Maximum length is 255 characters

required

The first line of the address

Billing.Address.AddressLine2
string

string:

Maximum length is 255 characters

optional

The second line of the address

Billing.Address.City
string

string:

Maximum length is 255 characters

required

The city of the address

Billing.Address.Region
string

string:

Maximum length is 255 characters

required

The region of the address - this is optional except if the Country is US, CA or MX

Billing.Address.PostalCode
string

string:

Maximum length is 50 characters

required

The postal code of the address - can be alphanumeric, dashes or spaces

Billing.Address.Country
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

required

The Country of the Address

SecureMode
SecureMode

SecureMode:

DEFAULT, FORCE, NO_CHOICE

optional

The SecureMode is used to select a 3DS1 and 3DS2 protocol for CB Visa and MasterCard. The field lets you ask for an Frictionless payment with the value "DEFAULT". The value "NO_CHOICE" will allow you to make the transaction eligible for Frictionless, but the exemption will be applied by the other payment actors. The value force "FORCE"will force customer authentification.

Culture
CultureCode

CultureCode:

DE, EN, ES, FR, IT, NL, PL, PT

optional

The language to use for the payment page - needs to be the ISO code of the language

CardId
string

string:

Maximum length is 255 characters

required

The ID of a card

SecureModeReturnURL
string

string:

Maximum length is 255 characters

required

This is the URL where users are automatically redirected after 3D secure validation (if activated)

StatementDescriptor
string

string:

Maximum length is 12 characters

optional

A custom description to appear on the user's bank statement. It can be up to 10 characters long, and can only include alphanumeric characters or spaces. See here for important info. Note that each bank handles this information differently, some show less or no information.

IpAddress
string

string:

Maximum length is 255 characters

required

IP Address of the end user (format IPV4 or IPV6)

BrowserInfo
BrowserInfo

BrowserInfo:

This object describes the Browser being user by an end user

View Sub-parameters

required

This object describes the Browser being user by an end user

BrowserInfo.AcceptHeader
string

string:

Maximum length is 255 characters

required

Exact content of the HTTP accept headers as sent to the merchant from the shopper’s browser

BrowserInfo.JavaEnabled
bool

bool:

true, false

required

Whether the user browser has Java enabled

BrowserInfo.Language
string

string:

Maximum length is 255 characters

required

Language of the browser of the user

BrowserInfo.ColorDepth
int

int

required

Value representing the bit depth of the colour palette for displaying images, in bits per pixel

BrowserInfo.ScreenHeight
int

int

required

The height of the screen in pixels

BrowserInfo.ScreenWidth
int

int

required

The width of the screen in pixels

BrowserInfo.TimeZoneOffset
int

int

required

UTC time offset in minutes

BrowserInfo.UserAgent
string

string:

Maximum length is 255 characters

required

Exact content of the HTTP user-agent header

BrowserInfo.JavascriptEnabled
bool

bool:

true, false

required

Whether the browser is Javascript enabled

Shipping
Shipping

Shipping:

View Sub-parameters

optional

Contains every useful information's related to the user shipping

Shipping.FirstName
string

string:

Maximum length is 100 characters

required

The name of the user.

Shipping.LastName
string

string:

Maximum length is 100 characters

required

The last name of the user.

Shipping.Address
Address

Address:

View Sub-parameters

required

The address

Shipping.Address.AddressLine1
string

string:

Maximum length is 255 characters

required

The first line of the address

Shipping.Address.AddressLine2
string

string:

Maximum length is 255 characters

optional

The second line of the address

Shipping.Address.City
string

string:

Maximum length is 255 characters

required

The city of the address

Shipping.Address.Region
string

string:

Maximum length is 255 characters

required

The region of the address - this is optional except if the Country is US, CA or MX

Shipping.Address.PostalCode
string

string:

Maximum length is 50 characters

required

The postal code of the address - can be alphanumeric, dashes or spaces

Shipping.Address.Country
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

required

The Country of the Address

  • View
  • Code
  • Run
  • View
  • Code
  • Run
POST .../preauthorizations/card/direct HTTP/1.1
Body Parameters :
{
"AuthorId": "8494514",
"DebitedFunds": {
"Currency": "lorem",
"Amount": 1260
},
"Billing": {
"FirstName": "Joe",
"LastName": "Blogs",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
},
"SecureMode": "DEFAULT",
"Culture": "EN",
"CardId": "14213157",
"SecureModeReturnURL": "http://www.my-site.com/returnURL",
"StatementDescriptor": "invoice 21",
"IpAddress": "2001:0620:0000:0000:0211:24FF:FE80:C12C",
"BrowserInfo": {
"AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
"JavaEnabled": true,
"Language": "FR-FR",
"ColorDepth": 4,
"ScreenHeight": 1800,
"ScreenWidth": 400,
"TimeZoneOffset": 60,
"UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
"JavascriptEnabled": true
},
"Shipping": {
"FirstName": "Joe",
"LastName": "Blogs",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
}
}
POST .../preauthorizations/card/direct HTTP/1.1
Body Parameters :
{
"AuthorId": "",
"DebitedFunds": {
"Currency": "",
"Amount":
},
"Billing": {
"FirstName": "",
"LastName": "",
"Address": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
}
},
"SecureMode": "",
"Culture": "",
"CardId": "",
"SecureModeReturnURL": "",
"StatementDescriptor": "",
"IpAddress": "",
"BrowserInfo": {
"AcceptHeader": "",
"JavaEnabled": "",
"Language": "",
"ColorDepth": ,
"ScreenHeight": ,
"ScreenWidth": ,
"TimeZoneOffset": ,
"UserAgent": "",
"JavascriptEnabled": ""
},
"Shipping": {
"FirstName": "",
"LastName": "",
"Address": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
}
}
}

View a PreAuthorization

GET .../v2.01/ClientId

The ID of your client account

/preauthorizations/PreAuthorizationId

The ID of a card pre-authorisation

/
  • View
  • Code
  • Run
  • View
  • Code
  • Run
GET .../preauthorizations/:PreAuthorizationId/ HTTP/1.1
GET .../preauthorizations// HTTP/1.1

Cancel or Validate a PreAuthorization

Two options exist to close a PreAuthorization and release pre-authorized funds before the PreAuthorisation expires. The parameter PaymentStatus can either be changed to CANCELED or VALIDATED. Please refer to multi-capture for further information.

Cancel a PreAuthorization: Where no captures have been made or will be made against a pre-authorization, the PreAuthorization can be canceled by changing the PaymentStatus parameter to CANCELED. A canceled pre-authorization cannot be reused. Please note: using this call against a PreAuthorization with at least one capture will generate an error and the PreAuthorization will not be closed.

Validate a PreAuthorization: Where at least one capture has been made against a pre-authorization and there are pre-authorized funds remaining, the PreAuthorization can be closed by changing the PaymentStatus parameter to VALIDATED Please note: using this call on a PreAuthorization where no captures have been made will generate an error. If no captures will be made, please cancel the pre-authorization.

PUT .../v2.01/ClientId

The ID of your client account

/preauthorizations/PreAuthorizationId

The ID of a card pre-authorisation

/

Parameters

PaymentStatus
PaymentStatus

PaymentStatus:

WAITING, CANCELED, EXPIRED, VALIDATED

The status of the payment for a preauthorization or a deposit preauthorization

required

The status of the payment after the PreAuthorization. You can pass the PaymentStatus from "WAITING" to "CANCELED" should you need/want to

  • View
  • Code
  • Run
  • View
  • Code
  • Run
PUT .../preauthorizations/:PreAuthorizationId/ HTTP/1.1
Body Parameters :
{
"PaymentStatus": "CANCELED"
}
PUT .../preauthorizations// HTTP/1.1
Body Parameters :
{
"PaymentStatus": ""
}

List preauthorizations for a card

GET .../v2.01/ClientId

The ID of your client account

/cards/CardId

The ID of a card

/preauthorizations

Get parameters

ResultCode
string

string:

Maximum length is 255 characters

optional

The result code of the transaction (you can filter your transactions list by multiple ResultCode values, each one must be separated by a comma)

Status
PreAuthorizationStatus

PreAuthorizationStatus:

CREATED , SUCCEEDED, FAILED

The status of the preauthorization

optional

Status of the PreAuthorization

PaymentStatus
PaymentStatus

PaymentStatus:

WAITING, CANCELED, EXPIRED, VALIDATED

The status of the payment for a preauthorization or a deposit preauthorization

optional

The status of the payment after the PreAuthorization. You can pass the PaymentStatus from "WAITING" to "CANCELED" should you need/want to

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../cards/:CardId/preauthorizations HTTP/1.1
Get Parameters :
{
"ResultCode": "000000,009199",
"Status": "CREATED",
"PaymentStatus": "WAITING"
}
GET .../cards//preauthorizations HTTP/1.1
Get Parameters :
{
"ResultCode": "",
"Status": "",
"PaymentStatus": ""
}

List preauthorizations for a user

GET .../v2.01/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

/preauthorizations

Get parameters

Status
PreAuthorizationStatus

PreAuthorizationStatus:

CREATED , SUCCEEDED, FAILED

The status of the preauthorization

optional

Status of the PreAuthorization

ResultCode
string

string:

Maximum length is 255 characters

optional

The result code of the transaction (you can filter your transactions list by multiple ResultCode values, each one must be separated by a comma)

PaymentStatus
PaymentStatus

PaymentStatus:

WAITING, CANCELED, EXPIRED, VALIDATED

The status of the payment for a preauthorization or a deposit preauthorization

optional

The status of the payment after the PreAuthorization. You can pass the PaymentStatus from "WAITING" to "CANCELED" should you need/want to

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../users/:UserId/preauthorizations HTTP/1.1
Get Parameters :
{
"Status": "CREATED",
"ResultCode": "000000,009199",
"PaymentStatus": "WAITING"
}
GET .../users//preauthorizations HTTP/1.1
Get Parameters :
{
"Status": "",
"ResultCode": "",
"PaymentStatus": ""
}

The Deposit PreAuthorization object

The Deposit Preauthorization object ensures the solvency of a registered card for 30 days. The overall process is as follows:

  1. Register a card (CardRegistration)
  2. Create a Deposit Preauthorization with the CardId. This allows you to charge an amount on a card.
  3. Charge the card using the PreAuthorized Deposit Payin (/payins/deposit-preauthorized/direct/full-capture)

How does Deposit work?

  • Once the Deposit object is created, the Status is “CREATED” until 3DSecure validation.
  • If the authorization is successful, the Status is “SUCCEEDED”, else the Status is “FAILED”
  • Once Status = “SUCCEEDED” and PaymentStatus = “WAITING”, you can charge the card or cancel the deposit.
  • The pay-in amount has to be less than or equal to the amount authorized else you will receive an HTTP 400 Bad Request error message
  • Multi-capture is not available with the Deposit PreAuthorization object
  • The same card restrictions applicable to the PreAuthorization object are applicable to the Deposit PreAuthorization object
  • Note that a deposit is automatically canceled after the ExpirationDate if you do not cancel it yourself, nor do a pay-in with it.

Parameters

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

AuthorId
string

string:

Maximum length is 255 characters

A user's ID

DebitedFunds
MoneyCard

MoneyCard:

View Sub-parameters

Information about the funds that are being debited

DebitedFunds.Currency
CurrencyCard

CurrencyCard:

AED, AUD, CAD, CHF, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR

The currency of the card payment - should be ISO_4217 format

DebitedFunds.Amount
int

int

An amount of money in the smallest sub-division of the currency, e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY would be represented as just 12)

Status
DepositStatus

DepositStatus:

CREATED , SUCCEEDED, FAILED

The status of the deposit.

The status of the deposit preauthorization.

PaymentStatus
PaymentStatus

PaymentStatus:

WAITING, CANCELED, EXPIRED, VALIDATED

The status of the payment for a preauthorization or a deposit preauthorization

The status of the payment after the deposit preauthorization. You can pass the PaymentStatus from "WAITING" to "CANCELED" should you need/want to.

PayinsLinked
PayinsLinked

PayinsLinked:

View Sub-parameters

Details about payments related to the deposit object.

PayinsLinked.PayinCaptureId
string

string:

Maximum length is 255 characters

The unique identifier of the pay-in made after the deposit creation if it is successful.

ResultCode
string

string:

Maximum length is 255 characters

The result code

ResultMessage
string

string:

Maximum length is 255 characters

A verbal explanation of the ResultCode

CardId
string

string:

Maximum length is 255 characters

The ID of a card

SecureModeReturnURL
string

string:

Maximum length is 255 characters

This is the URL where users are automatically redirected after 3D secure validation (if activated)

SecureModeNeeded
bool

bool:

true, false

The value is 'true' if the SecureMode was used

SecureModeRedirectURL
string

string:

Maximum length is 255 characters

This is the URL where to redirect users to proceed to 3D secure validation

ExpirationDate
timestamp

timestamp

The date and time at which the Deposit object is to expire (30 days after its creation). Therefore, the payment must be processed before this date.

PaymentType
PayInPaymentType

PayInPaymentType:

CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIRE

The payment type of the payin

The type of pay-in

ExecutionType
DepositExecutionType

DepositExecutionType:

DIRECT

The execution type for a deposit preauthorization

How the deposit preauthorization has been executed

StatementDescriptor
string

string:

Maximum length is 255 characters

A custom description to appear on the user's bank statement. It can be up to 10 characters long, and can only include alphanumeric characters or spaces. See here for important info. Note that each bank handles this information differently, some show less or no information.

Culture
CultureCode

CultureCode:

DE, EN, ES, FR, IT, NL, PL, PT

The language to use for the payment page - needs to be the ISO code of the language

IpAddress
string

string:

Maximum length is 255 characters

IP Address of the end user (format IPV4 or IPV6)

BrowserInfo
BrowserInfo

BrowserInfo:

This object describes the Browser being user by an end user

View Sub-parameters

This object describes the Browser being user by an end user

BrowserInfo.AcceptHeader
string

string:

Maximum length is 255 characters

Exact content of the HTTP accept headers as sent to the merchant from the shopper’s browser

BrowserInfo.JavaEnabled
bool

bool:

true, false

Whether the user browser has Java enabled

BrowserInfo.Language
string

string:

Maximum length is 255 characters

Language of the browser of the user

BrowserInfo.ColorDepth
int

int

Value representing the bit depth of the colour palette for displaying images, in bits per pixel

BrowserInfo.ScreenHeight
int

int

The height of the screen in pixels

BrowserInfo.ScreenWidth
int

int

The width of the screen in pixels

BrowserInfo.TimeZoneOffset
int

int

UTC time offset in minutes

BrowserInfo.UserAgent
string

string:

Maximum length is 255 characters

Exact content of the HTTP user-agent header

BrowserInfo.JavascriptEnabled
bool

bool:

true, false

Whether the browser is Javascript enabled

Billing
Billing

Billing:

View Sub-parameters

Contains every useful informations related to the user billing

Billing.FirstName
string

string:

Maximum length is 255 characters

The name of the user.

Billing.LastName
string

string:

Maximum length is 255 characters

The last name of the user.

Billing.Address
Address

Address:

View Sub-parameters

The address

Billing.Address.AddressLine1
string

string:

Maximum length is 255 characters

The first line of the address

Billing.Address.AddressLine2
string

string:

Maximum length is 255 characters

The second line of the address

Billing.Address.City
string

string:

Maximum length is 255 characters

The city of the address

Billing.Address.Region
string

string:

Maximum length is 255 characters

The region of the address - this is optional except if the Country is US, CA or MX

Billing.Address.PostalCode
string

string:

Maximum length is 50 characters

The postal code of the address - can be alphanumeric, dashes or spaces

Billing.Address.Country
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

The Country of the Address

Shipping
Shipping

Shipping:

View Sub-parameters

Contains every useful information's related to the user shipping

Shipping.FirstName
string

string:

Maximum length is 100 characters

The name of the user.

Shipping.LastName
string

string:

Maximum length is 100 characters

The last name of the user.

Shipping.Address
Address

Address:

View Sub-parameters

The address

Shipping.Address.AddressLine1
string

string:

Maximum length is 255 characters

The first line of the address

Shipping.Address.AddressLine2
string

string:

Maximum length is 255 characters

The second line of the address

Shipping.Address.City
string

string:

Maximum length is 255 characters

The city of the address

Shipping.Address.Region
string

string:

Maximum length is 255 characters

The region of the address - this is optional except if the Country is US, CA or MX

Shipping.Address.PostalCode
string

string:

Maximum length is 50 characters

The postal code of the address - can be alphanumeric, dashes or spaces

Shipping.Address.Country
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

The Country of the Address

Requested3DSVersion
3DSVersion

3DSVersion:

V1, V2_1

The 3DS version to be applied to the transaction.

Applied3DSVersion
3DSVersion

3DSVersion:

V1, V2_1

The 3DS version applied to the transaction.

{
"Id": "8494514",
"CreationDate": 12926321,
"AuthorId": "8494514",
"DebitedFunds": {
"Currency": "lorem",
"Amount": 1260
},
"Status": "CREATED",
"PaymentStatus": "CANCELED",
"PayinsLinked": {
"PayinCaptureId": "45649451"
},
"ResultCode": "000000",
"ResultMessage": "The transaction was successful",
"CardId": "14213157",
"SecureModeReturnURL": "http://www.my-site.com/returnURL",
"SecureModeNeeded": false,
"SecureModeRedirectURL": "http://www.a-url.com/3DS-redirect",
"ExpirationDate": 1658928779,
"PaymentType": "CARD",
"ExecutionType": "DIRECT",
"StatementDescriptor": "lorem",
"Culture": "EN",
"IpAddress": "2001:0620:0000:0000:0211:24FF:FE80:C12C",
"BrowserInfo": {
"AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
"JavaEnabled": true,
"Language": "FR-FR",
"ColorDepth": 4,
"ScreenHeight": 1800,
"ScreenWidth": 400,
"TimeZoneOffset": 60,
"UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
"JavascriptEnabled": true
},
"Billing": {
"FirstName": "Joe",
"LastName": "Blogs",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
},
"Shipping": {
"FirstName": "Joe",
"LastName": "Blogs",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
},
"Requested3DSVersion": "V2_1",
"Applied3DSVersion": "V2_1"
}

Create a Deposit PreAuthorization

POST .../v2.01/ClientId

The ID of your client account

/deposit-preauthorizations/card/direct

Parameters

AuthorId
string

string:

Maximum length is 255 characters

required

A user's ID

DebitedFunds
MoneyCard

MoneyCard:

View Sub-parameters

required

Information about the funds that are being debited

DebitedFunds.Currency
CurrencyCard

CurrencyCard:

AED, AUD, CAD, CHF, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR

required

The currency of the card payment - should be ISO_4217 format

DebitedFunds.Amount
int

int

required

An amount of money in the smallest sub-division of the currency, e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY would be represented as just 12)

CardId
string

string:

Maximum length is 255 characters

required

The ID of a card

SecureModeReturnURL
string

string:

Maximum length is 255 characters

required

This is the URL where users are automatically redirected after 3D secure validation (if activated)

StatementDescriptor
string

string:

Maximum length is 255 characters

optional

A custom description to appear on the user's bank statement. It can be up to 10 characters long, and can only include alphanumeric characters or spaces. See here for important info. Note that each bank handles this information differently, some show less or no information.

Culture
CultureCode

CultureCode:

DE, EN, ES, FR, IT, NL, PL, PT

optional

The language to use for the payment page - needs to be the ISO code of the language

IpAddress
string

string:

Maximum length is 255 characters

required

IP Address of the end user (format IPV4 or IPV6)

BrowserInfo
BrowserInfo

BrowserInfo:

This object describes the Browser being user by an end user

View Sub-parameters

required

This object describes the Browser being user by an end user

BrowserInfo.AcceptHeader
string

string:

Maximum length is 255 characters

required

Exact content of the HTTP accept headers as sent to the merchant from the shopper’s browser

BrowserInfo.JavaEnabled
bool

bool:

true, false

required

Whether the user browser has Java enabled

BrowserInfo.Language
string

string:

Maximum length is 255 characters

required

Language of the browser of the user

BrowserInfo.ColorDepth
int

int

required

Value representing the bit depth of the colour palette for displaying images, in bits per pixel

BrowserInfo.ScreenHeight
int

int

required

The height of the screen in pixels

BrowserInfo.ScreenWidth
int

int

required

The width of the screen in pixels

BrowserInfo.TimeZoneOffset
int

int

required

UTC time offset in minutes

BrowserInfo.UserAgent
string

string:

Maximum length is 255 characters

required

Exact content of the HTTP user-agent header

BrowserInfo.JavascriptEnabled
bool

bool:

true, false

required

Whether the browser is Javascript enabled

Billing
Billing

Billing:

View Sub-parameters

optional

Contains every useful informations related to the user billing

Billing.FirstName
string

string:

Maximum length is 255 characters

required

The name of the user.

Billing.LastName
string

string:

Maximum length is 255 characters

required

The last name of the user.

Billing.Address
Address

Address:

View Sub-parameters

required

The address

Billing.Address.AddressLine1
string

string:

Maximum length is 255 characters

required

The first line of the address

Billing.Address.AddressLine2
string

string:

Maximum length is 255 characters

optional

The second line of the address

Billing.Address.City
string

string:

Maximum length is 255 characters

required

The city of the address

Billing.Address.Region
string

string:

Maximum length is 255 characters

required

The region of the address - this is optional except if the Country is US, CA or MX

Billing.Address.PostalCode
string

string:

Maximum length is 50 characters

required

The postal code of the address - can be alphanumeric, dashes or spaces

Billing.Address.Country
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

required

The Country of the Address

Shipping
Shipping

Shipping:

View Sub-parameters

optional

Contains every useful information's related to the user shipping

Shipping.FirstName
string

string:

Maximum length is 100 characters

required

The name of the user.

Shipping.LastName
string

string:

Maximum length is 100 characters

required

The last name of the user.

Shipping.Address
Address

Address:

View Sub-parameters

required

The address

Shipping.Address.AddressLine1
string

string:

Maximum length is 255 characters

required

The first line of the address

Shipping.Address.AddressLine2
string

string:

Maximum length is 255 characters

optional

The second line of the address

Shipping.Address.City
string

string:

Maximum length is 255 characters

required

The city of the address

Shipping.Address.Region
string

string:

Maximum length is 255 characters

required

The region of the address - this is optional except if the Country is US, CA or MX

Shipping.Address.PostalCode
string

string:

Maximum length is 50 characters

required

The postal code of the address - can be alphanumeric, dashes or spaces

Shipping.Address.Country
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

required

The Country of the Address

  • View
  • Code
    A code sample is not available
  • Run
    A demo is not available
  • View
  • Code
    A code sample is not available
  • Run
    A demo is not available
POST .../deposit-preauthorizations/card/direct HTTP/1.1
Body Parameters :
{
"AuthorId": "8494514",
"DebitedFunds": {
"Currency": "lorem",
"Amount": 1260
},
"CardId": "14213157",
"SecureModeReturnURL": "http://www.my-site.com/returnURL",
"StatementDescriptor": "lorem",
"Culture": "EN",
"IpAddress": "2001:0620:0000:0000:0211:24FF:FE80:C12C",
"BrowserInfo": {
"AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
"JavaEnabled": true,
"Language": "FR-FR",
"ColorDepth": 4,
"ScreenHeight": 1800,
"ScreenWidth": 400,
"TimeZoneOffset": 60,
"UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
"JavascriptEnabled": true
},
"Billing": {
"FirstName": "Joe",
"LastName": "Blogs",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
},
"Shipping": {
"FirstName": "Joe",
"LastName": "Blogs",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
}
}

Cancel a Deposit PreAuthorization

When no capture has been made or will be made against a preauthorization, the Deposit PreAuthorization can be canceled by changing the PaymentStatus parameter to “CANCELED”. A canceled pre-authorization cannot be re-used.

Deposit Preauthorizations can only be canceled when:

  • The Status value is “SUCCEEDED”
  • The PaymentStatus value is “WAITING”
PUT .../v2.01/ClientId

The ID of your client account

/deposit-preauthorizations/DepositId

The unique identifier of the deposit

Parameters

PaymentStatus
PaymentStatus

PaymentStatus:

WAITING, CANCELED, EXPIRED, VALIDATED

The status of the payment for a preauthorization or a deposit preauthorization

optional

The status of the payment after the deposit preauthorization. You can pass the PaymentStatus from "WAITING" to "CANCELED" should you need/want to.

  • View
  • Code
    A code sample is not available
  • Run
    A demo is not available
  • View
  • Code
    A code sample is not available
  • Run
    A demo is not available
PUT .../deposit-preauthorizations/:DepositId HTTP/1.1
Body Parameters :
{
"PaymentStatus": "CANCELED"
}

View a Deposit PreAuthorization

GET .../v2.01/ClientId

The ID of your client account

/deposit-preauthorizations/DepositId

The unique identifier of the deposit

  • View
  • Code
    A code sample is not available
  • Run
    A demo is not available
  • View
  • Code
    A code sample is not available
  • Run
    A demo is not available
GET .../deposit-preauthorizations/:DepositId HTTP/1.1
Share feedback