Deposit with credit card

This method is used to make a server-side deposit into a merchant's account with a shopper's debit or credit card.

Request example

POST mpi/{{API_KEY}}/deposit/credit-card
Content-Type: application/json
Host: {{API_URL}}.bridgerpay.com
Authorization: Bearer {{ACCESS_TOKEN}}
{
"cashier_key": "{{CASHIER_KEY}}",
"order_id": "g173aa11",
"first_name": "John",
"last_name": "Smith",
"email": "[email protected]",
"currency": "EUR",
"country": "BE",
"state": null,
"address1": "Rue du Pont Simon 115",
"city": "Appelterre-eichem",
"zip_code": "9900",
"amount": 15.1,
"phone": "+328141112233",
"affiliate_id": null,
"tracking_id": null,
"payload": null,
"card_holder_name": "John Smith",
"credit_card_number": "4012888888881881",
"expire_month": 1,
"expire_year": 2022,
"cvv2": "111",
"date_of_birth": "1991/10/01",
"personal_id": "",
"bank_account_name": ""
}

post
MPI deposit request

<URL>/mpi/{{API_KEY}}/deposit/credit-card
This method is used to make a server-side deposit into a merchant's account with a shopper's debit or credit card.
Request
Response
Request
Path Parameters
API_KEY
required
string
Software-level credentials that identify a merchant and ensure secure access to sensitive information; provided by BridgerPay
Headers
Content-Type
required
string
Data format to present information in the response; only "application/json" is supported
Host
optional
string
Web domain identifier
Authorization
required
string
Authorization mechanism: Bearer {{ACCESS_TOKEN}}
Body Parameters
cashier_key
required
string
Software-level credentials that identify a merchant when creating a Cashier session; provided by BridgerPay
order_id
required
string
Transaction ID within the merchant's system
first_name
required
string
Shopper's first name
last_name
required
string
Shopper's last name
email
required
string
Shopper's email address
currency
required
string
Currency which the shopper's transaction is to be originated in; designated according to ISO 4217 — Currency Codes (e.g. "USD", "CNY", or "EUR")
country
required
string
Shopper's country, i.e. the country where the transaction is to be created; designated according to ISO 3166-1 — Country Codes (e.g. "US", "CN", or "BE")
state
optional
string
Shopper's state; applicable to the USA, Canada, and Australia
address1
required
string
Shopper's address
city
required
string
Shopper's city
zip_code
required
string
Shopper's ZIP code
amount
required
number
Transaction amount; must be more than 0
phone
required
string
Shopper's phone number
affiliate_id
optional
string
Affiliate or intermediary ID
tracking_id
optional
string
Tracking ID associated with the affiliate or intermediary
payload
optional
string
Message transmitted with the other data to match the sessions when the shopper's following financial operation (e.g. deposit with a credit card) is approved. It is used for ensuring additional security
card_holder_name
required
string
Holder name of the shopper's debit or credit card
credit_card_number
required
number
Number of the debit or credit card
expire_month
required
integer
Expiration month of the debit or credit card
expire_year
required
integer
Expiration year of the debit or credit card
cvv2
required
string
"Card Verification Value", i.e. the security code of the debit or credit card
birth_date
optional
string
Shopper's birthdate; epoch format for providers: RealDeposit & SaltarPay
personal_id
optional
string
Shopper's ID number
bank_account_name
optional
integer
Name of the shopper's bank account
Response
200: OK
Successful response
{
"response": {
"status": "success", //Response status
"type": null, //Error type
"code": 200, //Response code
"message": "OK" //Comment associated with the response
},
"result": {
"mpi_url": "https:...", //Link to a dialog box interacting with the shopper;
//it shows the current status of the transaction or asks to enter a security code to confirm the payment
"amount": 15.1, //Transaction amount
"currency": "EUR", //Transaction currency
"order_id": "g173aa11", //Transaction ID within the merchant's system
"credit_card_bin": "000011", //Bank identifier number; refers to the initial set of four or six numbers that appear on a payment card
"created_date": 1595426508 //UTC timestamp of when the request was processed by BridgerPay
"status": "in_process", //Transaction status
"id": "aeea2...a03" //Transaction ID within the BridgerPay system
}
}
400: Bad Request
1) One or more required parameters are missing or have incorrect format (failure message: "One or more of the required fields are missing, please try again") 2) Specified debit or credit card is invalid
{
"response": {
"status": "error",
"type": null,
"code": 400,
"message": "Bad request"
}
"result": {
"transaction_id": "79f9419a", //Transaction ID within the PSP's system
"amount": 15.1,
"currency": "EUR",
"credit_card_masked": "4580xxxxxxxx0001",
"captured": true,
"paynet_processing_date": "2018-10-13 22:42:15",
"failure_code": "expired_card",
"failure_message": "The card has expired.",
"status": "declined",
"id": "abba3...z05"
}
}
401: Unauthorized
Attempt to access the resource without merchant authorization (empty response)
402: Payment Required
Payment has been declined by the PSP
{
"response": {
"status": "error",
"type": null,
"code": 402,
"message": "Request Failed"
},
"result": [
{
"type": "do_not_try_again",
"message": "Card has been declined, please contact your credit company or our support."
}
]
}
413: Request Entity Too Large
Maximum length of the "payload" parameter has been exceeded
{
"response": {
"status": "error",
"type": null,
"code": 413,
"message": "Payload Too Large"
}
"result": null
}
415: Unsupported Media Type
Content-Type header parameter has not been provided, or the specified value is not supported by BridgerPay (empty response)