Documentation V3
  • Localpayment documentation V3
  • INTRODUCTION TO OUR SOLUTION
    • Intro to our Documentation
    • Intro to Payment Methods in Emerging Markets
    • Merchant Dashboard
      • Dashboard Navigation
      • Login
      • User Roles
      • Roles
      • Users
      • Whitelist your IPs
      • Whitelist your BINs
      • Setup your Webhooks
      • Reports
        • Balance
        • Projected Balance
        • Activity
        • Transaction Detail
        • FIDES Report
      • Virtual accounts
      • Refunds
        • Refund Bank Transfer
        • Refund Card Capture
        • Refund Cash
      • Chargeback
      • Internal Domestic Transfer
      • Internal Foreign Transfer
      • Currency Exchange
        • Create
      • Wire In
      • Wire Out
    • Intro to FX operations
    • Business definitions
      • Payins
      • Payouts
    • Onboarding & Integration
    • Postman Collection
  • ENVIRONMENTS
    • Environments
  • BEFORE A PAYMENT
    • Access Token
    • Validations
      • Document Validation
      • Bank Account Validation
      • Validate BIN
    • Holidays
    • Search Payment Method
    • Search Bank Codes
    • Cash Agents Geolocalization
    • Installments Plan Quote
    • Currency Exchange Quote
    • Billing Service
      • Create
        • Mexico
      • Check Billing status
      • Download Billing
  • REQUEST A PAYMENT
    • Payins
      • Bank Transfer
        • Direct debit
          • DEBIN (Argentina)
          • Transfiya (Colombia)
          • Wallet Fri (Guatemala)
        • Virtual Account
          • Mexico
            • Request Individual
            • Request Batch
            • Check Virtual account
            • Delete Virtual account
            • Enable or Disable Virtual Account
          • Brazil
            • Request Individual
            • Check Virtual account
            • Alias ​​configuration
          • Argentina
            • Request Individual
            • Request Batch
            • Check virtual account
            • Delete Virtual account
          • Refund Virtual Account
        • Online Reference Code Payments
          • Mexico
        • Refund Bank Transfer
        • Cancel
        • APMs
          • CODI (Mexico)
          • ETPAY (Chile)
          • Fintoc (Chile)
          • Boleto (Brazil)
          • PIX (Brazil)
            • Refund Pix
          • PSE (Colombia)
          • QR (Bolivia)
          • QR (Guatemala)
          • QR (Argentina)
          • QR (Perú)
      • Cash
        • Cash
          • APMs
            • Boleto (Brazil)
        • Cancel
        • Refund Cash
      • Debit Card
        • Capture
        • Refund Capture
      • Credit Card
        • Capture
        • Create Authorization
        • Capture Authorization
        • Cancel Authorization
        • Refund Capture
        • Installments
        • Save Cards
          • Save Card
          • Get Card
          • Delete Card
        • 3D-Secure
        • Validate card
        • Chargebacks
          • Notification
          • Send documentation
          • Close Chargeback
    • Payin Subscriptions
      • Create a subscription
      • Update subscription
      • Cancel
    • Payin Subscriptions Plan
      • Create subscription plan
      • Update subscription plan
      • Get subscription plan
    • Payouts
      • Search available banks
      • Create
        • Argentina
        • Bolivia
        • Brazil
        • Chile
        • Colombia
          • Colombia ACH
          • Colombia Transfiya
        • Costa Rica
        • Dominic Republic
        • Guatemala
        • Honduras
        • Mexico
        • Panama
        • Peru
        • Kenya
      • Manual Upload
        • Create Batch Upload
        • Batch Pending Authorization
        • Cancel Batch Pending Authorization
        • Batch Activity
      • Proof of Payment (POP)
      • Cancel
      • Commit payout
      • Attach documents
      • Ripplenet getway
    • Payouts Double Signature
      • Authorize
    • Checkout
      • Webcheckout
        • Credit Card
        • Debit Card
        • Cash
        • Bank Transfer
      • Link Payment
      • Frequent Items
      • Iframe
      • Smart Checkout/ iframe
      • Virtual Pos
      • Plugins
        • Magento
        • Shopify
        • Google Pay
        • WooCommerce
  • AFTER A PAYMENT
    • Check Status
    • Check Payment
    • Check Payment list
    • Check Subscription
    • Account Balance
      • Balance Reconciliation
      • Current Balance Amount
    • Withholding Certificates
    • Proof of Payment
    • RFI - Documentation
  • SETTLEMENT & EXCHANGE
    • Wire In
    • Wire Out
    • Currency Exchange Bulk
      • Quote
      • Bulk
      • Currency exchange - Front end
    • Internal Transfers
      • Internal Domestic Transfer
      • Internal Foreign Transfer
  • NOTIFICATIONS
    • Callbacks - Webhooks
      • Configurations
      • Payins
        • Payin Bank Transfer
        • PSE Colombia
        • Payin Virtual Account
        • Payin Cash
        • Payin Credit Card
        • Payin Debit Card
      • Payouts
    • SFTP- Email Reports
  • API REFERENCE GUIDE
    • Validation Error Codes
    • Transaction Type & Status
      • Payin
      • Subscriptions
      • Payout
      • Chargeback
      • Credit
      • Currency Exchange
      • Debit
      • Expenses
      • Internal Transfer
      • Recall
      • Refund
      • Return
      • Recurring Fee
      • Wire in
      • Wire out
    • Payout Methods + SLA
      • Latam
    • Payin Methods + SLA
      • Argentina
      • Bolivia
      • Brazil
      • Chile
      • Colombia
      • Dominican Republic
      • Guatemala
      • Mexico
      • Panama
      • Peru
    • Currency Codes
      • Latam
    • Country Codes
      • Latam
    • Bank codes
      • Latam
        • Argentina
        • Bolivia
        • Brazil
        • Chile
        • Colombia
        • Costa Rica
        • Dominican Republic
        • Guatemala
        • Honduras
        • Mexico
        • Panamá
        • Peru
    • Bank account validations
      • Latam
        • Argentina
        • Bolivia
        • Brazil
        • Chile
        • Colombia
        • Costa Rica
        • Dominican Republic
        • Guatemala
        • Mexico
        • Panama
        • Peru
    • Document Validations
      • Argentina
      • Bolivia
      • Brazil
      • Chile
      • Colombia
      • Costa Rica
      • Dominican Republic
      • El Salvador
      • Guatemala
      • Honduras
      • Mexico
      • Panama
      • Peru
    • Concept Codes
  • FLOWS AND CHARACTERISTICS
    • Account Currencies
    • Involved Parties
    • Payin Status Flow
      • Payins
        • Payin Status Flow - Card
        • Payin Status Flow - Bank
        • Payin Status Flow -Cash
      • Refund - Card
      • Refund - Cash & Bank
      • Chargeback
    • Payout Status Flow
      • Payout - Bank
      • Return
      • Recall
    • Payin Subscription Flow
      • Payins Subscription Status Flow - Card
    • Virtual Account Status Flow
    • Settlement Status Flow
      • Wire In
      • Wire Out
    • Payin Methods Flow
      • Argentina
      • Bolivia
      • Brazil
      • Chile
      • Colombia
      • Dominican Republic
      • Guatemala
      • Honduras
      • Mexico
      • Panama
      • Peru
  • HOLIDAYS
    • 2021
    • 2022
    • 2023
    • 2024
    • 2025
  • COMPLIANCE
    • Values
    • Prohibited Countries
    • Prohibited Business
    • Compliance Program Docs
    • Licenses
    • Terms & Conditions
  • GLOSSARY
    • Payments Explained
    • FAQ
  • PLUGINS
    • Magento
    • Shopify
    • Google Pay
    • WooCommerce
    • Ripplenet
Powered by GitBook
On this page
  • Credit Card Capture
  • Examples: Credit Card Payin (one step)
  • Examples: Save a Card on a Payment
  • Examples: Reuse a previously Saved Card

Was this helpful?

  1. REQUEST A PAYMENT
  2. Payins
  3. Credit Card

Capture

Post a credit card payment order: one step

Credit Card Capture

POST https://api.stage.localpayment.com /api/payin

Create a Credit Card Payin (one step)

Headers

Name
Type
Description

Authorization*

string

Mandatory. JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication

Request Body

Name
Type
Description

paymentMethod*

OBJECT

Mandatory. Payment method details

paymentMethod.type*

string

Mandatory. CreditCard.

paymentMethod.code*

string

paymentMethod.flow*

string

Mandatory. The payment method data could be embeded in the API request (DIRECT)or collected via an aditional form or plugin (REDIRECT). Currently, only DIRECT flow is allowed.

externalId*

string

Mandatory. An ID that is meaningful to you and your system. It must be unique and alphanumeric, no characters allowed.

country*

string

amount*

number

Mandatory. Amount to charge to your end user.

currency*

string

Mandatory. The currency in which the amount is expressed. It could be A) the local currency of the selected country or B) the account's currency. If A), the amount will be charged to the customer's cash payment method. If B) and it differs from the local currency, the amount specified will be credited to your account and Localpayment will perform a Foreign Exchange operation to collect the amount expressed in local currency. In bimonetary countries, paymentMethod.code resolves possible ambiguity: the payment will be executed in the currency of that specific payment method network. e.i.: SPID (USD); SPEI (MXN)

accountNumber*

string

Mandatory. Your Localpayment account number in which the amount will be credited.

conceptCode

string

comment

string

Optional. A comment related to the transaction. It should be something meaningful to your business.

exchangeRateToken

string

payer*

OBJECT

Mandatory. Party Object. Information related to the payer.

type*

string

Mandatory. Possible values: COMPANY, INDIVIDUAL

name*

string

Mandatory. INDIVIDUAL/COMPANY name (Please enter the name as it is shown on the card)

lastName

string

Mandatory for INDIVIDUAL / Ignored forCOMPANY.

document*

OBJECT

document.type*

string

document.id*

string

Mandatory. Identity document Id. Usually numbers or combination of numbers and letters.

userReference

string

Optional. Username or id in your platform.

email*

string

Mandatory.

phone

OBJECT

Optional. Party Object. Contact phone number

phone.countryCode

string

Optional.

phone.areaCode

string

Optional

phone.number

string

Optional

birthdate

string

Optional. Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD)

nationality

string

Optional

address

OBJECT

Optional. Party Object. Contact address

address.street

string

Optional

address.number

string

Optional

address.city

string

Optional

address.state

string

Optional

address.country

string

Optional

address.zipCode

string

Optional. Zip code / Postal code

address.comment

string

Optional. Additional info, such as floor or apartment number.

intermediaries

array

Optional. Array of Party objects. It represents others parties in the payment chain because of the end user is not your direct customer. Take into account the array sequence: your client should be the first element, the client of your client should be the second and so on, until there are no more intermediaries.

device

OBJECT

Optional.

device.id

string

Optional. Android / iPhone device ID. Can be blank for other device types such as PC / Mac.

device.ip

string

Optional. Device IP address

device.browser

string

Optional. Browser

metaData

OBJECT

Optional. Unstructured object to record any metadata meaningful to you.

commercialData

OBJECT

Optional. Party Object. Extra information related to the goods or services traded.

lastName

string

Optional only for INDIVIDUAL type / Ignored for COMPANY.

name*

string

Mandatory. INDIVIDUAL/COMPANY name

merchant*

OBJECT

Mandatory. Party Object.

type*

string

Mandatory. Possible values: COMPANY, INDIVIDUAL

document.type

string

Optional. Document type (related to the merchant's residence)

phone.countryCode

string

Optional.

phone

OBJECT

Optional. Party Object. Contact phone number

email

string

Optional.

userReference

string

Optional. Username or id in your platform.

document.id

string

Optional. Identity document id. Usually numbers or combination of numbers and letters.

document

OBJECT

Optional. Party Object.

address

OBJECT

Optional. Party Object. Contact address

nationality

string

Optional.

birthdate

string

Optional. Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD).

phone.number

string

Optional.

phone.areaCode

string

Optional.

address.comment

string

Optional. Additional info, such as floor or apartment number.

address.city

string

Optional.

address.number

string

Optional.

address.street

string

Optional.

address.zipCode

string

Optional. Zip code / Postal code

address.country

string

Optional.

address.state

string

Optional.

card*

OBJECT

Mandatory. Party Object. Payer CREDIT CARD data.

card.name*

string

Mandatory. Cardholder name, as printed on the front of the debitcard.

card.expirationMonth*

string

Mandatory. Card expiration month. Format MM.

card.cvv*

string

Mandatory. Card Verification Value

card.number*

number

Mandatory. Card number (PAN)

card.expirationYear*

string

Mandatory. Card expiration year. Format YYYY

item.id

string

Optional. Item ID

invoice

string

Optional. Invoice reference

item

array

Optional. List of sold items

items.quantity

number

Optional. Item quantity

items.categoryId

string

Optional. Item category

items.pictureUrl

string

Optional. URL pointing to an item picture

items.description

string

Optional. Item description

item.title

string

Optional. Item title

items.unitPrice

number

Optional. Unit price

shipments.city

string

Optional. City

shipments.number

string

Optional. Number address

shipments.street

string

Optional. Street address

shipments

array

Optional. List of shipping addresses

shipments.country

string

Optional. State/Province

shipments.state

string

Optional. State/ProvinceShipping country

shipments.comment

string

Optional. Additional info

shipments.zipCode

string

Optional. Zip code

lastName

string

Optional only for INDIVIDUAL type / Ignored for COMPANY.

beneficiary

OBJECT

Optional. Party Object.

name

string

Optional.INDIVIDUAL/COMPANY name

type

string

Optional. Possible values: COMPANY, INDIVIDUAL

email

string

Optional.

document.id

string

Optional. Identity document id. Usually numbers or combination of numbers and letters.

document.type

string

Optional. Document type (related to the beneficiary's residence)

document

OBJECT

Optional. Party Object.

card.save

bool

{
    "transactionType": "PayIn",
    "externalId": "1652986963",
    "internalId": "22f29c98-9baf-44bd-a164-1863ae2f1bb3",
    "paymentMethod": {
        "type": "CreditCard",
        "code": "1000",
        "flow": "DIRECT"
    },
    "country": "ARG",
    "currency": "ARS",
    "amount": 1002.0,
    "accountNumber": "032.032.00000001",
    "confirmed": {
        "currency": "ARS",
        "amount": 1002.0,
        "fxQuote": 1.0,
        "exchangeRateToken": null
    },
    "payment": {
        "installment": null,
        "currency": "ARS",
        "fxQuote": 1.0,
        "financingFee": 0.0,
        "amount": 1002.0
    },
    "localTaxes": [],
    "withHoldings": [],
    "fees": {
        "description": "Fee",
        "currency": "ARS",
        "fxSource": 210.8,
        "fxQuote": 1.0,
        "amount": 13.02,
        "account": "032.032.00000001"
    },
    "status": {
        "code": "103",
        "description": "APPROVED",
        "detail": "The payin was confirmed but not credited yet"
    },
    "ticket": null,
    "qr": null,
    "beneficiary": null,
    "merchant": {
        "type": "COMPANY",
        "name": "Merchant's name",
        "lastname": "",
        "document": null,
        "email": null,
        "phone": null,
        "address": null,
        "birthdate": null,
        "nationality": null
    },
    "payer": {
        "type": "INDIVIDUAL",
        "name": "Payer's name",
        "lastname": "Payer's last name",
        "document": {
            "id": "37895247",
            "type": "DNI"
        },
        "email": "payer@mail.com",
        "phone": {
            "countryCode": "1",
            "areaCode": "11",
            "number": "98789632"
        },
        "address": null,
        "birthdate": null,
        "nationality": null
    },
    "intermediaries": [],
    "wireInstructions": null,
    "date": {
        "creationDate": "2022-05-19T19:02:44.018+00:00",
        "processedDate": "2022-05-19T19:02:44.799618",
        "expirationDate": "0001-01-01T00:00:00"
    },
    "card": {
        "token": "N66a0BVHGJY/oCwOyl/CbxIJ5DmCINWeir9PY9gxVGI=",
        "bin": "402670",
        "brand": "VISA",
        "country": "RS",
        "name": "Cardholder Name",
        "last4": "3263",
        "expirationYear": 2025,
        "expirationMonth": 9
    },
    "errors": []
}
 
{
    "transactionType": null,
    "externalId": null,
    "internalId": null,
    "paymentMethod": null,
    "country": null,
    "currency": null,
    "amount": null,
    "accountNumber": null,
    "confirmed": null,
    "payment": null,
    "localTaxes": null,
    "withHoldings": null,
    "fees": null,
    "status": null,
    "ticket": null,
    "qr": null,
    "beneficiary": null,
    "merchant": null,
    "payer": null,
    "intermediaries": null,
    "wireInstructions": null,
    "date": null,
    "card": null,
    "errors": [
        {
            "code": "809",
            "description": "Rejected",
            "detail": "Invalid card number length"
        },
        {
            "code": "801",
            "description": "Rejected",
            "detail": "Params error  card number, invalid format "
        }
    ]
}

Examples: Credit Card Payin (one step)

To create a credit card payment order, the request body examples are detailed below.

curl --location 'https://api.stage.localpayment.com/api/payin/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjgzMTI1MzczLCJqdGkiOiI3ZTVjOGZiMWRjMzc0ZjAwYTAzZjA3YWVlYjExZjVmZiIsInVzZXJfaWQiOjIwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjp0cnVlLCJyb2xlcyI6WyJJU19BRE1JTiJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDA1IiwiY2xpZW50X2NvZGUiOiIwMDA1In0.ThL-9iOu0FErglbU3Oz5ZT83-SVLSV_LfgDYNmanMW4' \
--data-raw '{
	"paymentMethod": {
		"type": "CreditCard",
		"code": "1000",
		"flow": "DIRECT"
	},
	"externalId": "1111100000",
	"country": "ARG",
	"currency": "ARS",
	"amount": 100.00,
	"accountNumber": "032.032.00000000",
	"conceptCode": "0001",
	"comment": "APPROVED",
	"1exchangeRateToken": "5153b12e-ed59-4444-0000-123450",
	"merchant": {
		"type": "INDIVIDUAL",
		"name": "Netflix Argentina",
		"lastname": "Solo si es type INDIVIDUAL",
		"document": {
			"id": "3000091105",
			"type": "CUIT"
		},
		"email": "netflix.argentina@gmail.com",
		"phone": {
			"countryCode": "1",
			"areaCode": "11",
			"number": "92222222"
		},
		"birthdate": "1994-02-20",
		"nationality": "Argentino",
		"address": {
			"street": "Charruas",
			"number": "938",
			"city": "Hurlingham",
			"state": "state",
			"country": "Argentina",
			"zipCode": "1688",
			"comment": "portero 801"
		}
	},
	"payer": {
		"type": "INDIVIDUAL",
		"name": "Fernando",
		"lastname": "Gomez",
		"document": {
			"id": "37993831",
			"type": "DNI"
		},
		"email": "nicolas123@localpayment.com",
		"phone": {
			"countryCode": "1",
			"areaCode": "11",
			"number": "98189634"
		}
	},
	"intermediaries": [],
	"metaData": {
		"1finalStatus": "APPROVED",
        "2finalStatus": "INPROGRESS"
	},
    "card": {
		"name": "APPRO",
		"number": "4970100000000055",
		"cvv": "123",
		"expirationMonth": "11",
		"expirationYear": "2025",
		"installments": 1,
        "save": false
	}
}'    
curl --location 'https://api.stage.localpayment.com/api/payin/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjg1OTc1MTU2LCJqdGkiOiI0MzgzMTMxNDA0ZTM0MmE5YmNhNzU4ZWNhZWVlNDc5MSIsInVzZXJfaWQiOjQzMSwic3VwZXJ1c2VyIjp0cnVlLCJpc19zdGFmZiI6ZmFsc2UsInJvbGVzIjpbIkFMTCJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDI2IiwiY2xpZW50X2NvZGUiOiIwMDI2In0.buazk9bPO-chLBETxoWKoudnsMYXF55NtrN3PQebO_0' \
--data-raw '{
	"paymentMethod": {
		"type": "CreditCard",
		"code": "1000",
		"flow": "DIRECT"
	},
	"externalId": "{$timestamp}}",
	"country": "ARG",
	"currency": "ARS",
	"amount": 100.00,
	"accountNumber": "032.032.00000000",
	"conceptCode": "0001",
	"comment": "APPROVED",
	"1exchangeRateToken": "1685575027",
	"merchant": {
		"type": "INDIVIDUAL",
		"name": "Netflix Argentina",
		"lastname": "Solo si es type INDIVIDUAL",
		"document": {
			"id": "30552251405",
			"type": "CUIT"
		},
		"email": "netflix.argentina@gmail.com",
		"phone": {
			"countryCode": "1",
			"areaCode": "11",
			"number": "98729632"
		},
		"birthdate": "1994-02-20",
		"nationality": "Argentino",
		"address": {
			"street": "Charruas",
			"number": "938",
			"city": "Hurlingham",
			"state": "state",
			"country": "Argentina",
			"zipCode": "1688",
			"comment": "portero 801"
		}
	},
	"payer": {
		"type": "INDIVIDUAL",
		"name": "Fernando",
		"lastname": "Gomez",
		"document": {
			"id": "37993831",
			"type": "DNI"
		},
		"email": "nicolas123@localpayment.com",
		"phone": {
			"countryCode": "1",
			"areaCode": "11",
			"number": "98999632"
		}
	},
	"intermediaries": [],
	"metaData": {
		"1finalStatus": "APPROVED",
        "2finalStatus": "INPROGRESS"
	},
    "card": {
		"name": "APPRO",
		"number": "4970100000000055",
		"cvv": "123",
		"expirationMonth": "11",
		"expirationYear": "2025",
		"installments": 1,
        "save": true
	}
}
'
curl --location 
--request POST 'https://api.stage.localpayment.com/api/payin/' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjUwMjkyNTIwLCJqdGkiOiJiNjY5MzRmZGFmMTA0NzVjYTlkZTc1MDM5ZTgyNDFhMSIsInVzZXJfaWQiOjMwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjpmYWxzZSwicm9sZXMiOlsiQUxMIl0sImNvdW50cmllcyI6WyJBTEwiXSwiY29tcGFueSI6IjAwMDEiLCJjbGllbnRfY29kZSI6IjAwMDEifQ.yb_ChDljTFD7zgR9MdpQR0-hPba37A38GRh_2k6veuo' \
--header 'Content-Type: application/json' \
--data-raw '{
    "paymentMethod":{
        "type":"CreditCard",
        "code":"1000",
        "flow":"DIRECT"
    },
    "externalId":"1650292410",
    "country":"ARG",
    "amount":100,
    "currency":"ARS",
    "accountNumber":"032.032.00000001",
    "conceptCode":"0003",
    "comment":"Add any relevant information related to the transaction",
    "merchant":{
        "type":"COMPANY",
        "name":"Company name",
        "lastname":"",
        "document":{
            "type":"CUIT",
            "id":"30-99903208-3"
        },
        "userReference":"abc123",
        "email":"company@mail.com",
        "phone":{
            "countryCode":"54",
            "areaCode":"11",
            "number":"98789632"
        },
        "birthdate":"2000-01-01",
        "nationality":"nationality",
        "address":{
            "street":"Street",
            "number":"938",
            "city":"city",
            "state":"state",
            "country":"country",
            "zipCode":"zipCode",
            "comment":"Add any usefull information"
        }
    },
    "payer":{
        "type":"INDIVIDUAL",
        "name":"Payer'\''s name",
        "lastname":"Payer'\''s last name",
        "document":{
            "id":"99999999",
            "type":"DNI"
        },
        "email":"payer@mail.com",
        "phone":{
            "countryCode":"1",
            "areaCode":"11",
            "number":"98789632"
        },
        "birthdate":"01/01/1990",
        "nationality":"nationality",
        "address":{
            "street":"Street",
            "number":"1234",
            "city":"city",
            "state":"state",
            "country":"country",
            "zipCode":"zipCode",
            "comment":"Add any relevant information related to the payer"
        },
        "userReference":"abcdef1"
    },
    "card":{
        "name":"Cardholder name",
        "number":"4012888888881881",
        "cvv":"123",
        "expirationMonth":"11",
        "expirationYear":"2027",
        "installments":1
    },
    "intermediaries":[
        
    ],
    "commercialData":{
        "invoice":"",
        "items":[
            {
                "id":"",
                "title":"",
                "description":"",
                "pictureUrl":"",
                "categoryId":"",
                "quantity": 0,
                "unitPrice": 0.0
            }
        ],
        "shipments":[
            {
                "street":"",
                "number":"",
                "city":"",
                "state":"",
                "contry":"",
                "zipCode":"",
                "comment":""
            }
        ]
    },
    "device":{
        "deviceId":"",
        "ip":"",
        "browser":""
    },
    "metaData":{
        
    }
}'

{
    "transactionType": "PayIn",
    "externalId": "11111111111",
    "internalId": "3e2c521e-279b-494d-828b-c77bf8e53ddd",
    "paymentMethod": {
        "type": "CreditCard",
        "code": "1000",
        "flow": "DIRECT"
    },
    "country": "ARG",
    "currency": "ARS",
    "amount": 100.0,
    "accountNumber": "032.032.00000000",
    "confirmed": {
        "currency": "ARS",
        "amount": 100.0,
        "fxQuote": 1.0
    },
    "payment": {
        "currency": "ARS",
        "fxQuote": 1.0,
        "financingFee": 0.0,
        "amount": 100.0
    },
    "localTaxes": [
        {
            "code": "0001",
            "percentage": 1.2,
            "description": "IDC",
            "currency": "ARS",
            "fxSource": 240.831749,
            "fxQuote": 0.0,
            "amount": 1.2,
            "account": "032.032.00000000"
        }
    ],
    "withHoldings": [],
    "fees": {
        "description": "Fee",
        "currency": "ARS",
        "fxSource": 240.831749,
        "fxQuote": 1.0,
        "amount": 5.0,
        "account": "032.032.0000000"
    },
    "status": {
        "code": "103",
        "description": "APPROVED",
        "detail": "The payin was confirmed but not credited yet"
    },
    "merchant": {
        "type": "INDIVIDUAL",
        "name": "Netflix Argentina",
        "lastname": "Solo si es type INDIVIDUAL",
        "document": {
            "type": "CUIT",
            "id": "30558251405"
        },
        "email": "netflix.argentina@gmail.com",
        "phone": {
            "countryCode": "1",
            "areaCode": "11",
            "number": "98759632"
        },
        "address": {
            "street": "Charruas",
            "number": "938",
            "city": "Hurlingham",
            "state": "state",
            "country": "Argentina",
            "zipCode": "1688",
            "comment": "portero 801"
        },
        "birthdate": "1994-02-20",
        "nationality": "Argentino"
    },
    "payer": {
        "type": "INDIVIDUAL",
        "name": "Fernando",
        "lastname": "Gomez",
        "document": {
            "type": "DNI",
            "id": "37993831"
        },
        "email": "nicolas123@localpayment.com",
        "phone": {
            "countryCode": "1",
            "areaCode": "11",
            "number": "98789532"
        }
    },
    "intermediaries": [],
    "date": {
        "creationDate": "2023-06-05T13:18:39.99+00:00",
        "processedDate": "2023-06-05T13:18:43.253231"
    },
    "card": {
        "token": "i7vMGH%2Bv%2BkJR64tzL1cLQKxHR%2FGVIgV6%2FQEI35AGuU8%3D",
        "bin": "497010",
        "brand": "VISA",
        "country": "MA",
        "name": "APPRO",
        "last4": "0055",
        "expirationYear": 2025,
        "expirationMonth": 11
    },
    "errors": []
}
{
  "errors": [
    {
      "code": "809",
      "description": "Rejected",
      "detail": "Invalid card number length"
    },
    {
      "code": "801",
      "description": "Rejected",
      "detail": "Params error card "
    },
    {
      "code": "803",
      "description": "Rejected",
      "detail": "Invalid card cvv"
    },
    {
      "code": "801",
      "description": "Rejected",
      "detail": "Params error  card number, invalid format "
    },
    {
      "code": "801",
      "description": "Rejected",
      "detail": "Params error expiration, already expired "
    }
  ]
}

Examples: Save a Card on a Payment

You can save a card while making a Payment / Authorization. To do so, simply add a "save" : true parameter in the card object of the request.

curl --location 'https://api.stage.localpayment.com/api/payin/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjg1OTc1MTU2LCJqdGkiOiI0MzgzMTMxNDA0ZTM0MmE5YmNhNzU4ZWNhZWVlNDc5MSIsInVzZXJfaWQiOjQzMSwic3VwZXJ1c2VyIjp0cnVlLCJpc19zdGFmZiI6ZmFsc2UsInJvbGVzIjpbIkFMTCJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDI2IiwiY2xpZW50X2NvZGUiOiIwMDI2In0.buazk9bPO-chLBETxoWKoudnsMYXF55NtrN3PQebO_0' \
--data-raw '{
	"paymentMethod": {
		"type": "CreditCard",
		"code": "1000",
		"flow": "DIRECT"
	},
	"externalId": "{{timestamp}}",
	"country": "ARG",
	"currency": "ARS",
	"amount": 100.00,
	"accountNumber": "032.032.00000000",
	"conceptCode": "0001",
	"comment": "APPROVED",
	"1exchangeRateToken": "1685575027",
	"merchant": {
		"type": "INDIVIDUAL",
		"name": "Netflix Argentina",
		"lastname": "Solo si es type INDIVIDUAL",
		"document": {
			"id": "30552251405",
			"type": "CUIT"
		},
		"email": "netflix.argentina@gmail.com",
		"phone": {
			"countryCode": "1",
			"areaCode": "11",
			"number": "98729632"
		},
		"birthdate": "1994-02-20",
		"nationality": "Argentino",
		"address": {
			"street": "Charruas",
			"number": "938",
			"city": "Hurlingham",
			"state": "state",
			"country": "Argentina",
			"zipCode": "1688",
			"comment": "portero 801"
		}
	},
	"payer": {
		"type": "INDIVIDUAL",
		"name": "Fernando",
		"lastname": "Gomez",
		"document": {
			"id": "37993831",
			"type": "DNI"
		},
		"email": "nicolas123@localpayment.com",
		"phone": {
			"countryCode": "1",
			"areaCode": "11",
			"number": "98999632"
		}
	},
	"intermediaries": [],
	"metaData": {
		"1finalStatus": "APPROVED",
        "2finalStatus": "INPROGRESS"
	},
    "card": {
		"name": "APPRO",
		"number": "4970100000000055",
		"cvv": "123",
		"expirationMonth": "11",
		"expirationYear": "2025",
		"installments": 1,
        "save": true
	}
}
'
{
    "transactionType": "PayIn",
    "externalId": "11111111111",
    "internalId": "3e2c521e-279b-494d-828b-c77bf8e53ddd",
    "paymentMethod": {
        "type": "CreditCard",
        "code": "1000",
        "flow": "DIRECT"
    },
    "country": "ARG",
    "currency": "ARS",
    "amount": 100.0,
    "accountNumber": "032.032.00000000",
    "confirmed": {
        "currency": "ARS",
        "amount": 100.0,
        "fxQuote": 1.0
    },
    "payment": {
        "currency": "ARS",
        "fxQuote": 1.0,
        "financingFee": 0.0,
        "amount": 100.0
    },
    "localTaxes": [
        {
            "code": "0001",
            "percentage": 1.2,
            "description": "IDC",
            "currency": "ARS",
            "fxSource": 240.831749,
            "fxQuote": 0.0,
            "amount": 1.2,
            "account": "032.032.00000000"
        }
    ],
    "withHoldings": [],
    "fees": {
        "description": "Fee",
        "currency": "ARS",
        "fxSource": 240.831749,
        "fxQuote": 1.0,
        "amount": 5.0,
        "account": "032.032.0000000"
    },
    "status": {
        "code": "103",
        "description": "APPROVED",
        "detail": "The payin was confirmed but not credited yet"
    },
    "merchant": {
        "type": "INDIVIDUAL",
        "name": "Netflix Argentina",
        "lastname": "Solo si es type INDIVIDUAL",
        "document": {
            "type": "CUIT",
            "id": "30558251405"
        },
        "email": "netflix.argentina@gmail.com",
        "phone": {
            "countryCode": "1",
            "areaCode": "11",
            "number": "98759632"
        },
        "address": {
            "street": "Charruas",
            "number": "938",
            "city": "Hurlingham",
            "state": "state",
            "country": "Argentina",
            "zipCode": "1688",
            "comment": "portero 801"
        },
        "birthdate": "1994-02-20",
        "nationality": "Argentino"
    },
    "payer": {
        "type": "INDIVIDUAL",
        "name": "Fernando",
        "lastname": "Gomez",
        "document": {
            "type": "DNI",
            "id": "37993831"
        },
        "email": "nicolas123@localpayment.com",
        "phone": {
            "countryCode": "1",
            "areaCode": "11",
            "number": "98789532"
        }
    },
    "intermediaries": [],
    "date": {
        "creationDate": "2023-06-05T13:18:39.99+00:00",
        "processedDate": "2023-06-05T13:18:43.253231"
    },
    "card": {
        "token": "i7vMGH%2Bv%2BkJR64tzL1cLQKxHR%2FGVIgV6%2FQEI35AGuU8%3D",
        "bin": "497010",
        "brand": "VISA",
        "country": "MA",
        "name": "APPRO",
        "last4": "0055",
        "expirationYear": 2025,
        "expirationMonth": 11
    },
    "errors": []
}

Examples: Reuse a previously Saved Card

You can use a previously saved card to make a Payin

curl --location 'https://api.stage.localpayment.com/api/payin/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjgzMTI1NzYxLCJqdGkiOiI0MGI1ZGUxNjVmNDQ0OGIwYmMxNjcxMWI3YTdmOWQ2NCIsInVzZXJfaWQiOjIwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjp0cnVlLCJyb2xlcyI6WyJJU19BRE1JTiJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDA1IiwiY2xpZW50X2NvZGUiOiIwMDA1In0.yRg6MmgRGk_HO_ettMTSJWn2RP6k6Er4BczgGmm0tq4' \
--data-raw '{
	"paymentMethod": {
		"type": "CreditCard",
		"code": "1000",
		"flow": "DIRECT"
	},
	"externalId": "{{timestamp}}",
	"country": "ARG",
	"currency": "ARS",
	"amount": 1000.00,
	"accountNumber": "032.032.00000000",
	"conceptCode": "0001",
	"comment": "APPROVED",
	"1exchangeRateToken": "5153b89e-xx11-4244-xx11-1x1x1f6cec50",
	"merchant": {
		"type": "INDIVIDUAL",
		"name": "Netflix Argentina",
		"lastname": "Solo si es type INDIVIDUAL",
		"document": {
			"id": "30551151405",
			"type": "CUIT"
		},
		"email": "netflix.argentina@gmail.com",
		"phone": {
			"countryCode": "1",
			"areaCode": "11",
			"number": "11789632"
		},
		"birthdate": "1994-02-20",
		"nationality": "Argentino",
		"address": {
			"street": "Charruas",
			"number": "938",
			"city": "Hurlingham",
			"state": "state",
			"country": "Argentina",
			"zipCode": "1688",
			"comment": "portero 801"
		}
	},
	"payer": {
		"type": "INDIVIDUAL",
		"name": "Fernando",
		"lastname": "Gomez",
		"document": {
			"id": "37993111",
			"type": "DNI"
		},
		"email": "1mp-middleware@localpayment.com",
		"phone": {
			"countryCode": "1",
			"areaCode": "11",
			"number": "98789632"
		}
	},
	"intermediaries": [],
	"metaData": {
		"1finalStatus": "APPROVED",
        "2finalStatus": "INPROGRESS"
	},
    "card": {
		"token": "WleV6CZ785IMxxx11SIrqzOn3JsGKCef8oBh2mbi56M%3D",
        "installments": "1"
	}
}'
{
  "transactionType": "PayIn",
  "externalId": "1668199223",
  "internalId": "2dcc352a-84dc-4b02-9dc1-c0f523ac06a7",
  "paymentMethod": {
    "type": "CreditCard",
    "code": "1000",
    "flow": "DIRECT"
  },
  "country": "ARG",
  "currency": "ARS",
  "amount": 50,
  "accountNumber": "032.032.00000015",
  "confirmed": {
    "currency": "ARS",
    "amount": 50,
    "fxQuote": 1
  },
  "payment": {
    "currency": "ARS",
    "fxQuote": 1,
    "financingFee": 0,
    "amount": 50
  },
  "localTaxes": [],
  "withHoldings": [],
  "fees": {
    "description": "Fee",
    "currency": "USD",
    "fxSource": 1.000268,
    "fxQuote": 1,
    "amount": 1.01,
    "account": "032.840.00000001"
  },
  "status": {
    "code": "103",
    "description": "APPROVED",
    "detail": "The payin was confirmed but not credited yet"
  },
  "merchant": {
    "type": "COMPANY",
    "name": "Merchant's name",
    "lastname": "",
    "document": {
      "type": "",
      "id": ""
    },
    "email": "",
    "address": {
      "street": "Charruas",
      "number": "938",
      "city": "Hurlingham",
      "state": "state",
      "country": "Argentina",
      "zipCode": "1688",
      "comment": "portero 801"
    },
    "birthdate": "2000-01-01",
    "nationality": "Argentinian"
  },
  "payer": {
    "type": "INDIVIDUAL",
    "name": "Payer's name",
    "lastname": "Payer's Last name",
    "document": {
      "type": "DNI",
      "id": "11111111"
    },
    "email": "payer@mail.com",
    "phone": {
      "countryCode": "1",
      "areaCode": "11",
      "number": "12341234"
    },
    "address": {
      "street": "Siempre viva",
      "number": "1234",
      "city": "Springfield",
      "state": "Ohio",
      "country": "USA",
      "zipCode": "1686",
      "comment": "May the force be with you, always!"
    },
    "birthdate": "01/01/1990",
    "nationality": "Argentinian"
  },
  "intermediaries": [],
  "date": {
    "creationDate": "2022-11-11T20:40:23.456+00:00",
    "processedDate": "2022-11-11T20:40:25.133352"
  },
  "card": {
    "token": "hka5VF9q5TJjayelOtQm9kupakp7sfjhZSwPHMAiQpU=",
    "bin": "407865",
    "brand": "VISA",
    "country": "AR",
    "name": "Cardholder Name",
    "last4": "3201",
    "expirationYear": 2027,
    "expirationMonth": 3
  },
  "errors": []
}
{
  "errors": [
    {
      "code": "300",
      "description": "REJECTED",
      "detail": "Invalid param token, not previously saved"
    }
  ]
}

Check the Payin Status Codes

Check the Card Payin Status Flow un the following section:

PreviousCredit CardNextCreate Authorization

Last updated 9 months ago

Was this helpful?

Mandatory. Select among the codes available in each country for a . NOTE: payment method code might affect the collection currency in bimonetary countries. For more info, see the side note on currency field.

Mandatory. Your end user's country (i.e. country in which the payment will be processed), in ISO format. Please refer to for a full list of supported countries.

Mandatory. Choose the suitable concept code from our . Based on our experience, the most usual are 0039 (remittances) and 0040 (corporate payments).

Optional. Token provided by the in order to use an upfront agreed exchange rate.

Mandatory.Party Object.

Mandatory. Document types.

Please refer to to learn more about the document type required for the different payment methods by country.

this article
Payin
Payin Status Flow - Card
Country Codes
Concept Code List
Foreign Exchange service
Valid identity document.
Check the regonized document type list per country
payin BankTransfer payment type