PayCertify Docs

Charge an Account

POST https://gateway-api.paycertify.com/api/boletos/sale

Parameter	Type	Length	Presence	Description	Example
`processor_id`	`uuid`	36	Optional^[1]	The Processor record ID	41f00869-d7b3-413e-9476-9ef1a8bc2f28
`amount`	`number`	0.01-9999999	Required	Total transaction amount	3.56
`merchant_transaction_id`	`string`	1-255	Required	A merchant assigned identifier (your transaction ID)	my-order-id-0001
`first_name`	`string`	1-255	Required^[2]	Customer’s first name	Braziliano
`last_name`	`string`	1-255	Required^[2]	Customer’s last name	Babtiste
`email`	`string`	1-255	Required	Customer’s email	[email protected]
`document_number`	`string`	11-20	Required^[3]	The ID of the Identification document for the customer	00003456790
`mobile_phone`	`string`	11-15	Optional	Customer’s phone in E.164 format	+11231231234
`street_address_1`	`string`	1-255	Required^[2]	Billing address first line (street address)	Amazonstda
`street_address_2`	`string`	1-255	Optional^[2]	Billing address second line (suite, apt, etc)	Suite M
`city`	`string`	1-255	Required^[2]	Billing address city	Brasilia
`state`	`string`	2	Required^[2]	Billing address state abbreviation, ISO 3166-2 format.	SP
`country`	`string`	2	Required^[2]	Billing address country abbreviation, ISO 3166-1 alpha-2 format.	BR
`zip`	`string`	2-255	Required^[2]	Billing address postal code	12345678
`shipping_street_address_1`	`string`	1-255	Optional	Shipping address first line (street address)	Amazonstda
`shipping_street_address_2`	`string`	1-255	Optional	Shipping address second line (suite, apt, etc)	Suite M
`shipping_city`	`string`	1-255	Optional	Shipping address city	Brasilia
`shipping_state`	`string`	2	Optional	Shipping address state abbreviation, ISO 3166-2 format.	CA
`shipping_country`	`string`	2	Optional	Shipping address country abbreviation, in ISO 3166-1 alpha-2 format.	US
`shipping_zip`	`string`	5	Optional	Shipping address postal code	12345678
`ip_address`	`string`	12	Required	Customer’s IP address	192.168.108.105

[1] if processor_id has not been provided, the gateway will pick the record flagged as “default”. [2] required and minimum of 2 chars when running transactions with boleto processor. [3] The documents accepted are CPF : Tax payer identification number for individuals and CNPJ : Tax payer identification number for businesses

Parameter	Type	Length	Description	Example
`transaction.id`	`uuid`	36	This transaction’s ID	41f00869-d7b3-413e-9476-9ef1a8bc2f28
`transaction.merchant_id`	`uuid`	36	The user’s merchant ID	41f00869-d7b3-413e-9476-9ef1a8bc2f28
`transaction.user_id`	`uuid`	36	The user’s ID	41f00869-d7b3-413e-9476-9ef1a8bc2f28
`transaction.processor_id`	`uuid`	36	The processor’s ID	41f00869-d7b3-413e-9476-9ef1a8bc2f28
`transaction.merchant_transaction_id`	`string`	1-255	The merchant assigned identifier	my-order-id-0001
`transaction.boleto_url`	`string`	1-255	The URL to generate a visible and printable document to pay	https://test.com/….
`transaction.updated_at`	`datetime`	-	Last time this transaction was updated, on ISO 8601 UTC	2018-02-16T16:33:40+00:00
`transaction.created_at`	`datetime`	-	Time that transaction was created, on ISO 8601 UTC	2018-02-16T16:33:40+00:00
`transaction.events.*.id`	`uuid`	36	This event’s ID	41f00869-d7b3-413e-9476-9ef1a8bc2f28
`transaction.events.*.success`	`boolean`	-	If the event was a successful event or not	true
`transaction.events.*.event_type`	`string`	4-10	The type of event being performed	auth, capture, sale, void, refund
`transaction.events.*.amount`	`number`	0.01-9999999	Total event amount	3.56
`transaction.events.*.processor_code`	`string`	2-10	The processor response code	00
`transaction.events.*.processor_message`	`string`	1-255	A human readable message from the processor	APPROVAL V12341
`transaction.events.*.processor_transaction_id`	`string`	1-255	A processor assigned identifier	00000000143242
`transaction.events.*.updated_at`	`datetime`	-	Last time this event was updated, on ISO 8601 UTC	2018-02-16T16:33:40+00:00
`transaction.events.*.created_at`	`datetime`	-	Time that event was created, on ISO 8601 UTC	2018-02-16T16:33:40+00:00

PS: All fields that are included on the authorization message are also echoed back.

curl --request POST \
  --url https://gateway-api.paycertify.com/api/boletos/sale \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --form 'amount=1.00' \
  --form 'document_number=00003456790' \
  --form 'first_name=Braziliano' \
  --form 'last_name=Babtiste'\
  --form 'street_address_1=Amazonstda' \
  --form 'street_address_2=Suite M' \
  --form 'city=Brasilia' \
  --form 'state=SP' \
  --form 'country=BR' \
  --form 'ip_address=127.0.0.1' \
  --form 'dynamic_descripton=MY-DESCRIPTOR' \
  --form 'mobile_phone=+11231231234' \
  --form '[email protected]' \
  --form 'merchant_transaction_id=my-order-id-0001' \
  --form 'zip=95030'

Responds with:

{
  "transaction": {
    "id": "3410596f-d596-42d4-9811-41d43868e984",
    "merchant_id": "455a1c64-385b-41b2-a56f-34bf6c5c5335",
    "user_id": "6e064bf5-0e18-466b-811b-f967e8d73b9f",
    "processor_id": "30ff7682-6ec7-48f3-8d7a-62319a9c3c59",
    "account_number": "100000****0000",
    "check_number": "100000",
    "routing_number": "061103852",
    "first_name": "John",
    "last_name": "Doe",
    "updated_at": "2018-02-16T16:33:40+00:00",
    "created_at": "2018-02-16T16:33:39+00:00",
    "events": [
        {
            "id": "84a8ab86-ee0e-47d4-8686-4e42fa58355e",
            "success": true,
            "threeds_response": null,
            "avs_response": null,
            "event_type": "sale",
            "amount": "1.00",
            "ip_address": "127.0.0.1",
            "processor_code": "800.400.500",
            "processor_message": "WAITING_FOR_NON_INSTANT_PAYMENT",
            "processor_transaction_id": "000000000252616",
            "processor_threeds_response": null,
            "processor_avs_response": "0",
            "updated_at": "2018-02-16T16:33:40+00:00",
            "created_at": "2018-02-16T16:33:39+00:00"
        }
    ]
  }
}