Docs

Purchase Finalized V2

Webhook event sent when a purchase is finalized, including operation details, payment values, payment dates, approved and refused items, and related HATEOAS links.

When a purchase is finalized, after all seller and funder legal representatives complete the signatures, we send this event with information about who performed the operation, the amounts to be paid, and the payment dates.

You can use _links to navigate to the resources related to this event.

Path: /purchase

Webhook payload object

KeyTypeDescription

purchaseId


string

Purchase identifier.

auctionId


string

Auction identifier.

bidId


string

Bid identifier.

grossPaymentValue


number

Gross purchase amount.

netPaymentValue


number

Net purchase amount.

averageTax


number

Tax assigned to the purchase.

averageTenor


integer

Advance term in days.

paymentDate


long

Purchase payment date.

buyerName


string

funder's company name or full name.

buyerGovernmentId


string

funder's CNPJ or CPF.

buyerAddress


string

funder address.

buyerAddressNumber


string

funder address number.

buyerAddressComplement


string

funder address complement.

buyerNeighborhood


string

funder neighborhood.

buyerCity


string

funder city.

buyerState


string

funder state.

buyerCountry


string

funder country.

buyerZipCode


string

funder ZIP code.

buyerBank


string

funder bank code.

buyerAgency


string

funder bank branch code, without the digit.

buyerAccount


string

funder checking account, without the digit.

buyerAccountDigit


string

funder checking account digit.

sellerName


string

Seller's company name or full name.

sellerPersonType


string

Seller entity type.

Possible values are:
LEGAL_PERSON - Legal entity
NATURAL_PERSON - Individual


sellerGovernmentId


string

Seller's CNPJ or CPF.

sellerAddress


string

Seller address.

sellerAddressNumber


string

Seller address number.

sellerAddressComplement


string

Seller address complement.

sellerNeighborhood


string

Seller neighborhood.

sellerCity


string

Seller city.

sellerState


string

Seller state.

sellerCountry


string

Seller country.

sellerZipCode


string

Seller ZIP code.

sellerBank


string

Seller bank code.

sellerAgency


string

Seller bank branch code, without the digit.

sellerAgencyDigit


string

Seller branch digit.

sellerAccount


string

Seller checking account, without the digit.

sellerAccountDigit


string

Seller checking account digit.

status


string

Purchase status. Possible values:
SOLD - Advanced
REFUSED - Refused


sellerExternalCode


string

Agreement code.

approvedItems


array

Array containing the approved items in this purchase.

approvedItems[][uuid]


string

Receivable identifier on the platform.


approvedItems[][externalId]


string

External receivable identifier. (Up to 255 characters)


approvedItems[][invoiceDate]


long

Receivable date.


approvedItems[][invoiceNumber]


string

Receivable number. (Up to 255 characters)


approvedItems[][invoiceKey]


string

Electronic receivable key. (Up to 255 characters)


approvedItems[][installment]


integer

Installment related to the receivable. Used only when the receivable is paid in installments. When it is paid in full, the default value is 1.


approvedItems[][totalInstallment]


integer

Total installments related to the receivable. Used only when the receivable is paid in installments. When it is paid in full, the default value is 1.


approvedItems[][grossPaymentValue]


number

Receivable amount.


approvedItems[][netPaymentValue]


number

Amount assigned to the seller.


approvedItems[][paymentDate]


long

Receivable due date.


approvedItems[][effectivePaymentDate]


long

Receivable due date.


approvedItems[][tax]


number

Tax assigned to the purchase item.


approvedItems[][sponsorName]


string

Client's company name or full name.

approvedItems[][sponsorGovernmentId]


string

Client's CNPJ or CPF.


approvedItems[][sponsorAddress]


string

Client address.

approvedItems[][sponsorAddressNumber]


string

Client address number.

approvedItems[][sponsorAddressComplement]


string

Client address complement.

approvedItems[][sponsorNeighborhood]


string

Client neighborhood.

approvedItems[][sponsorCity]


string

Client city.

approvedItems[][sponsorState]


string

Client state.

approvedItems[][sponsorCountry]


string

Client country.

approvedItems[][sponsorZipCode]


string

Client ZIP code.

approvedItems[][sponsorBank]


string

Client bank code.

approvedItems[][sponsorAgency]


string

Client bank branch code, without the digit.

approvedItems[][sponsorAccount]


string

Client checking account, without the digit.

approvedItems[][sponsorAccountDigit]


string

Client checking account digit.

refusedItems


array

Array containing the refused items in this purchase.

refusedItems[][uuid]


string

Receivable identifier on the platform.


refusedItems[][externalId]


string

External receivable identifier. (Up to 255 characters)


refusedItems[][invoiceDate]


long

Receivable date.


refusedItems[][invoiceNumber]


string

Receivable number. (Up to 255 characters)


refusedItems[][invoiceKey]


string

Electronic receivable key. (Up to 255 characters)


refusedItems[][installment]


integer

Installment related to the receivable. Used only when the receivable is paid in installments. When it is paid in full, the default value is 1.


refusedItems[][totalInstallment]


integer

Total installments related to the receivable. Used only when the receivable is paid in installments. When it is paid in full, the default value is 1.


refusedItems[][grossPaymentValue]


number

Receivable amount.


refusedItems[][netPaymentValue]


number

Amount assigned to the seller.


refusedItems[][paymentDate]


long

Receivable due date.


refusedItems[][effectivePaymentDate]


long

Receivable due date.


refusedItems[][tax]


number

Tax assigned to the purchase item.


refusedItems[][sponsorName]


string

Client's company name or full name.

refusedItems[][sponsorGovernmentId]


string

Client's CNPJ or CPF.


refusedItems[][sponsorAddress]


string

Client address.

refusedItems[][sponsorAddressNumber]


string

Client address number.

refusedItems[][sponsorAddressComplement]


string

Client address complement.

refusedItems[][sponsorNeighborhood]


string

Client neighborhood.

refusedItems[][sponsorCity]


string

Client city.

refusedItems[][sponsorState]


string

Client state.

refusedItems[][sponsorCountry]


string

Client country.

refusedItems[][sponsorZipCode]


string

Client ZIP code.

refusedItems[][sponsorBank]


string

Client bank code.

refusedItems[][sponsorAgency]


string

Client bank branch code, without the digit.

refusedItems[][sponsorAccount]


string

Client checking account, without the digit.

refusedItems[][sponsorAccountDigit]


string

Client checking account digit.

_links


object

Resources available through HATEOAS.
To learn more, click here.

Available resources are:
purchase - List this purchase.
file - Purchase term.

Webhook payload example

{
	"purchaseId" : "f7Hrm6k7RR",
	"auctionId" : "f7Hrm6k7Rl",
	"bidId" : "6620a220-b400-4222-bb94-afbc029956be",
	"status" : "WAITING_CUSTODY",
	"averageTax" : 1.3345,
	"averageTenor" : 169,
	"paymentDate" : 1649041200000,
	"grossPaymentValue" : 50891.25,
	"netPaymentValue" : 22451.45,
	"buyerName" : "BUYER SALES FINANCE",
	"buyerGovernmentId" : "62144175000120",
	"sellerName" : "SALES SALES FINANCE",
	"sellerPersonType" : "LEGAL_PERSON",
	"sellerGovernmentId" : "57648355000109",
	"sellerAddress" : "RUA SELLER",
	"sellerAddressNumber" : "404",
	"sellerAddressComplement": "Seller",
	"sellerNeighborhood" : "Moema",
	"sellerCity" : "SÃO PAULO",
	"sellerState" : "SP",
	"sellerCountry" : "Brasil",
	"sellerZipCode" : "13801510",
	"sellerBank" : "001",
	"sellerAgency" : "2323",
	"sellerAgencyDigit" : "0",
	"sellerAccount" : "11100",
	"sellerAccountDigit" : "1",
	"createdAt" : 1649424623283,
	"items" : [
		{
			"uuid" : "7qohB0H6m1",
			"externalId" : "CX4119",
			"invoiceDate" : 1593054000000,
			"invoiceNumber" : "1287572-32",
			"invoiceKey" : "XV4119",
			"installment" : 1,
			"totalInstallment" : 1,
			"grossPaymentValue" : 11897.25,
			"paymentDate" : 1665975600000,
			"effectivePaymentDate" : 1665975600000,
			"tax" : 1.3345,
			"netPaymentValue" : "3569.54",
			"sponsorName" : "SPONSOR SALES FINANCE",
			"sponsorPersonType" : "LEGAL_PERSON",
			"sponsorGovernmentId" : "36147299000159",
			"sponsorAddress" : "Rua Sponsor",
			"sponsorAddressNumber" : "404",
			"sponsorAddressComplement" : "NA",
			"sponsorNeighborhood" : "Moeda",
			"sponsorCity" : "São Paulo",
			"sponsorState" : "SP",
			"sponsorCountry" : "Brasil",
			"sponsorZipCode" : "13801510",
			"sponsorBank" : "001",
			"sponsorAgency" : "2323",
			"sponsorAgencyDigit" : "0"
		}
	],
	"_links" : {
		"purchase" : {
			"href" : "https://gateway.sales.finance/v2/buyers/62144175000120/purchases/f7Hrm6k7RR",
			"type" : "GET"
		},
		"purchase-response" : {
			"href" : "https://gateway.sales.finance/v1/buyers/62144175000120/purchases/f7Hrm6k7RR/response",
			"type" : "POST"
		}
	}
}

Updated 19 days ago

Did this page help you?

© Monkey Tech . Todos os direitos reservados. Acesse nossa Política de Privacidade.