Body
Name | Type | Description |
---|---|---|
transactionId | string | Optional. Identifier for Conciliation of the Receiving Customer. Used by the Receiving Customer to reconcile the billing document (QR Code) with the actual payment. |
key | string | Optional. Pix key utilized in the process of receiving a pix. |
endToEndId | string | Unique payment transaction identifier. |
initiationType | enum | Type of mechanism used to initiate payment. Domains:MANUAL KEY QR_CODE_STATIC QR_CODE_DYNAMIC |
amount | number | Transaction amount |
payer|beneficiary | object | Information about the payer/beneficiary |
payer|beneficiary.number | string | Client’s account number - Required - Min length: 1 - Max length: 20 |
payer|beneficiary.branch | string | Client’s account branch - Required - Length: 4 |
payer|beneficiary.type | enum | Account type: Domains: CURRENT - Current AccountPAYMENT - Payment AccountSAVING - Saving AccountSALARY - Salary Account |
payer|beneficiary.participant | object | Payer/beneficiary participant |
payer|beneficiary.participant.ispb | string | Participant’s ISPB |
payer|beneficiary.holder | object | Infomation about the holder’s account |
payer|beneficiary.holder.document | string | Holder’s document (CPF or CNPJ) |
payer|beneficiary.holder.name | string | Holder’s name |
payer|beneficiary.holder.type | enum | Holder’s document type. Domains:NATURAL - Natural PersonLEGAL - Legal Person |
{
"endToEndId":"E0000000020231107221725nWTjsuxWh",
"initiationType":"MANUAL",
"amount":6.00,
"createdAt":"2023-11-07T22:17:25.339Z",
"payer":{
"number":"826953",
"branch":"9162",
"type":"CURRENT",
"participant":{
"ispb":"99999003"
},
"holder":{
"name":"CENTRO DE SAUDE CREDILUZ LTDA",
"document":"12345678901234",
"type":"LEGAL"
}
},
"beneficiary":{
"number":"10073",
"branch":"0001",
"type":"CURRENT",
"participant":{
"ispb":"1111111"
},
"holder":{
"name":"DOUGLAS DE ABREU",
"document":"12345678912",
"type":"NATURAL"
}
}
}
{
"key":"06130856555",
"endToEndId":"E0000000020231107221725nWTjsuxWh",
"initiationType":"KEY",
"amount":6.00,
"createdAt":"2023-11-07T22:17:25.339Z",
"payer":{
"number":"826953",
"branch":"9162",
"type":"CURRENT",
"participant":{
"ispb":"99999003"
},
"holder":{
"name":"CENTRO DE SAUDE CREDILUZ LTDA",
"document":"12345678901234",
"type":"LEGAL"
}
},
"beneficiary":{
"number":"10073",
"branch":"0001",
"type":"CURRENT",
"participant":{
"ispb":"1111111"
},
"holder":{
"name":"DOUGLAS DE ABREU",
"document":"12345678912",
"type":"NATURAL"
}
}
}
{
"key":"06130856555",
"endToEndId":"E0000000020231107221725nWTjsuxWh",
"transactionId":"REC00000000000000000000000000000001",
"initiationType":"QR_CODE_STATIC | QR_CODE_DYNAMIC",
"amount":6.00,
"createdAt":"2023-11-07T22:17:25.339Z",
"payer":{
"number":"826953",
"branch":"9162",
"type":"CURRENT",
"participant":{
"ispb":"99999003"
},
"holder":{
"name":"CENTRO DE SAUDE CREDILUZ LTDA",
"document":"12345678901234",
"type":"LEGAL"
}
},
"beneficiary":{
"number":"10073",
"branch":"0001",
"type":"CURRENT",
"participant":{
"ispb":"1111111"
},
"holder":{
"name":"DOUGLAS DE ABREU",
"document":"12345678912",
"type":"NATURAL"
}
}
}
Response
Below is the expected agreement to ensure the account crediting process is completed successfully.
HTTP 200
{
"participantRequestId": "45F763C6-7487-4363-9406-A1DE2A9636D3"
}