PIX

Receive a PIX Payment

8 min

this service allows your company to receive money through the pix payment method how does the user flow work? user creates a transaction with the pix payment method he receives a qrcode or a copy paste code the user accesses the bank of their choice and scan the qrcode or paste the code (emv) into the bank's application the amount is debited from his bank account and the transaction is completed with this feature you can create charge to your customer in that charge when has a due date you can set a set specificities such as abatement, fine, interest and discount endpoints create cashin on demand when requesttype equals ondemand you can fill ondemand ttl property to specify life time of charge curl request post \\ \ url https //www fastcash com br/apiv10/pix/v1/receive \\ \ header 'authorization fcx \<fcx token>' \\ \ header 'content type application/json' \\ \ data '{ 	"tid" "834aa64e 530e 4cee 91d4 58458dca3c82", 	"pid" \<pid>, 	"prodid" \<prodid>, 	"custom" "", 	"amount" 1 99, 	"fixedamount" false, 	"description" "teste 58133", 	"requesttype" "ondemand", 	"instructions" "teste", 	"customer" { 	 "name" "tester", 	 "email" "tester\@fastcash dev br", 	 "mobilephone" "11976552324", 	 "document" "80276158016" 	}, 	"ondemand" { 	 "ttl" 1000 	} }' scheduled scheduled when requesttype equals scheduled you can set various specificities of a scheduled charge on scheduled property and his children curl request post \\ \ url https //www fastcash com br/apiv10/pix/v1/receive \\ \ header 'authorization fcx \<fcx token>' \\ \ header 'content type application/json' \\ \ data '{ 	"tid" "8054a65a 808e 4d17 a194 4575d83eb0f1", 	"pid" \<pid>, 	"prodid" \<prodid>, 	"custom" null, 	"amount" 1 99, 	"description" "teste 74135", 	"requesttype" "scheduled", 	"instructions" "receba seu pix", 	"fixedamount" true, 	"ondemand" null, 	"scheduled" { 	 "duedate" "2021 09 20t21 46 47 748z", 	 "overduelimit" 1, 	 "abatement" { 	 "modality" 1, 	 "value" 0 90 	 }, 	 "fine" { 	 "modality" 1, 	 "value" 10 90 	 }, 	 "discount" { 	 "modality" 6, 	 "value" 50 	 }, 	 "interest" { 	 "modality" 2, 	 "value" 0 5 	 } 	}, 	"customer" { 	 "name" "tester", 	 "email" "tester\@fastcash dev br", 	 "mobilephone" "11976552324", 	 "document" "44568241405" 	} }' change cashin when you already have a pix cashin scheduled and it not is not completed yet you can change it curl request put \\ \ url http //localhost 8003/pix/v1/receive \\ \ header 'authorization fcx \<fcx token>' \\ \ header 'content type application/json' \\ \ data '{ 	"tid" "8054a65a 808e 4d17 a194 4575d83eb0f1", 	"pid" \<pid>, 	"requesttype" "scheduled", 	"amount" 9 99, 	"instructions" "receba seu pix harum iure", 	"location" null, 	"scheduled" { 	 "duedate" "2022 09 21t21 46 47 748z", 	 "overduelimit" 1, 	 "fine" { 	 "modality" 1, 	 "value" 10 90 	 }, 	 "discount" { 	 "modality" 6, 	 "value" 50 	 }, 	 "interest" { 	 "modality" 2, 	 "value" 0 5 	 } 	} }' schemas and validations abatement value should not be equals or greater than charge amount discount value should not be equals or greater than charge amount abatement required \ modality \ value properties modality type integer format int32 description > abatement applied on the charge 1 fixed value 2 percent value minimum 1 maximum 2 value type number description abatement or others deductions applied on the charge can be fixed or percent fine required \ modality \ value properties modality type integer format int32 description > fine applied on the charge 1 fixed value 2 percent value minimum 1 maximum 2 value type number description fine applied on the charge can be fixed or percent discount oneof \ required \ modality \ value \ required \ modality \ values properties modality type integer format int32 description > interest applied on the charge 1 fixed value until informed dates 2 percent value until informed dates 3 fixed value per day in advance 4 fixed value per business day in advance 5 percent value per day in advance 6 percent value per business day in advance minimum 1 maximum 6 value type number description discount applied on the charge can be fixed or percent according to modality \[when modality equals 3, 4, 5 or 6] values type array items properties date type string format date time value type number description discount applied on the charge can be fixed or percent according to modality \[when modality equals 1 or 2]